Move Bk2MnemonicLookup to BizHawk.Emulation.Common

YoshiRulz · YoshiRulz · commit 699fc8d198a2 · 2024-11-13T16:15:02.000+10:00
fixes a080086 (PR #3782)
diff --git a/src/BizHawk.Client.Common/inputAdapters/InputManager.cs b/src/BizHawk.Client.Common/inputAdapters/InputManager.cs
@@ -52,7 +52,7 @@ public class InputManager
 		public void SyncControls(IEmulator emulator, IMovieSession session, Config config)
 		{
 			var def = emulator.ControllerDefinition;
-			def.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(emulator.SystemId));
+			def.BuildMnemonicsCache(emulator.SystemId);
 
 			ActiveController = BindToDefinition(def, config.AllTrollers, config.AllTrollersAnalog, config.AllTrollersFeedbacks);
 			AutoFireController = BindToDefinitionAF(emulator, config.AllTrollersAutoFire, config.AutofireOn, config.AutofireOff);
diff --git a/src/BizHawk.Client.Common/movie/import/DsmImport.cs b/src/BizHawk.Client.Common/movie/import/DsmImport.cs
@@ -93,7 +93,7 @@ protected override void RunImport()
 
 		private void ImportInputFrame(string line)
 		{
-			DeSmuMEControllerDef.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+			DeSmuMEControllerDef.BuildMnemonicsCache(Result.Movie.SystemID);
 			SimpleController controller = new(DeSmuMEControllerDef);
 
 			controller["LidOpen"] = false;
diff --git a/src/BizHawk.Client.Common/movie/import/FcmImport.cs b/src/BizHawk.Client.Common/movie/import/FcmImport.cs
@@ -37,7 +37,7 @@ protected override void RunImport()
 				NesRightPort = nameof(ControllerNES)
 			};
 			_deck = controllerSettings.Instantiate((x, y) => true).AddSystemToControllerDef();
-			_deck.ControllerDef.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+			_deck.ControllerDef.BuildMnemonicsCache(Result.Movie.SystemID);
 
 			// 004 4-byte little-endian unsigned int: version number, must be 2
 			uint version = r.ReadUInt32();
diff --git a/src/BizHawk.Client.Common/movie/import/Fm2Import.cs b/src/BizHawk.Client.Common/movie/import/Fm2Import.cs
@@ -119,7 +119,7 @@ protected override void RunImport()
 					{
 						controllerSettings.NesLeftPort = nameof(ControllerNES);
 						_deck = controllerSettings.Instantiate((_, _) => false).AddSystemToControllerDef();
-						_deck.ControllerDef.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+						_deck.ControllerDef.BuildMnemonicsCache(Result.Movie.SystemID);
 					}
 				}
 				else if (line.StartsWith("port1", StringComparison.OrdinalIgnoreCase))
@@ -128,7 +128,7 @@ protected override void RunImport()
 					{
 						controllerSettings.NesRightPort = nameof(ControllerNES);
 						_deck = controllerSettings.Instantiate((_, _) => false).AddSystemToControllerDef();
-						_deck.ControllerDef.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+						_deck.ControllerDef.BuildMnemonicsCache(Result.Movie.SystemID);
 					}
 				}
 				else if (line.StartsWith("port2", StringComparison.OrdinalIgnoreCase))
@@ -147,7 +147,7 @@ protected override void RunImport()
 						controllerSettings.NesLeftPort = nameof(FourScore);
 						controllerSettings.NesRightPort = nameof(FourScore);
 						_deck = controllerSettings.Instantiate((_, _) => false).AddSystemToControllerDef();
-						_deck.ControllerDef.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+						_deck.ControllerDef.BuildMnemonicsCache(Result.Movie.SystemID);
 					}
 				}
 				else
diff --git a/src/BizHawk.Client.Common/movie/import/FmvImport.cs b/src/BizHawk.Client.Common/movie/import/FmvImport.cs
@@ -94,7 +94,7 @@ the file.
 				NesRightPort = controller2 ? nameof(ControllerNES) : nameof(UnpluggedNES)
 			};
 			_deck = controllerSettings.Instantiate((x, y) => true).AddSystemToControllerDef();
-			_deck.ControllerDef.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+			_deck.ControllerDef.BuildMnemonicsCache(Result.Movie.SystemID);
 			syncSettings.Controls.NesLeftPort = controllerSettings.NesLeftPort;
 			syncSettings.Controls.NesRightPort = controllerSettings.NesRightPort;
 
diff --git a/src/BizHawk.Client.Common/movie/import/GmvImport.cs b/src/BizHawk.Client.Common/movie/import/GmvImport.cs
@@ -90,7 +90,7 @@ protected override void RunImport()
 
 			GPGXControlConverter controlConverter = new(input, systemId: VSystemID.Raw.GEN, cdButtons: false);
 
-			controlConverter.ControllerDef.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+			controlConverter.ControllerDef.BuildMnemonicsCache(Result.Movie.SystemID);
 			SimpleController controller = new(controlConverter.ControllerDef);
 
 			// Unknown.
diff --git a/src/BizHawk.Client.Common/movie/import/LsmvImport.cs b/src/BizHawk.Client.Common/movie/import/LsmvImport.cs
@@ -84,7 +84,7 @@ protected override void RunImport()
 			}
 
 			ControllerDefinition controllerDefinition = new BsnesControllers(ss, true).Definition;
-			controllerDefinition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(VSystemID.Raw.SNES));
+			controllerDefinition.BuildMnemonicsCache(VSystemID.Raw.SNES);
 			_emptyController = new SimpleController(controllerDefinition);
 			_controller = new SimpleController(controllerDefinition);
 			_playerCount = controllerDefinition.PlayerCount;
diff --git a/src/BizHawk.Client.Common/movie/import/Mc2Import.cs b/src/BizHawk.Client.Common/movie/import/Mc2Import.cs
@@ -146,7 +146,7 @@ private void ImportTextFrame(string line)
 		{
 			var buttons = new[] { "Up", "Down", "Left", "Right", "B1", "B2", "Run", "Select" };
 
-			_deck.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+			_deck.Definition.BuildMnemonicsCache(Result.Movie.SystemID);
 			SimpleController controllers = new(_deck.Definition);
 
 			// Split up the sections of the frame.
diff --git a/src/BizHawk.Client.Common/movie/import/MmvImport.cs b/src/BizHawk.Client.Common/movie/import/MmvImport.cs
@@ -95,7 +95,7 @@ protected override void RunImport()
 
 			var ss = new SMS.SmsSyncSettings();
 			var cd = new SMSControllerDeck(ss.Port1, ss.Port2, isGameGear, ss.UseKeyboard);
-			cd.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+			cd.Definition.BuildMnemonicsCache(Result.Movie.SystemID);
 			SimpleController controllers = new(cd.Definition);
 
 			/*
diff --git a/src/BizHawk.Client.Common/movie/import/PjmImport.cs b/src/BizHawk.Client.Common/movie/import/PjmImport.cs
@@ -181,7 +181,7 @@ protected void ParseBinaryInputLog(BinaryReader br, IMovie movie, MiscHeaderInfo
 				OctoshockDll.ePeripheralType.None, OctoshockDll.ePeripheralType.None, OctoshockDll.ePeripheralType.None
 			};
 			SimpleController controllers = new(Octoshock.CreateControllerDefinition(settings));
-			controllers.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+			controllers.Definition.BuildMnemonicsCache(Result.Movie.SystemID);
 
 			string[] buttons =
 			{
@@ -292,7 +292,7 @@ protected void ParseTextInputLog(BinaryReader br, IMovie movie, MiscHeaderInfo i
 				OctoshockDll.ePeripheralType.None, OctoshockDll.ePeripheralType.None, OctoshockDll.ePeripheralType.None
 			};
 			SimpleController controllers = new(Octoshock.CreateControllerDefinition(settings));
-			controllers.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+			controllers.Definition.BuildMnemonicsCache(Result.Movie.SystemID);
 
 			string[] buttons =
 			{
diff --git a/src/BizHawk.Client.Common/movie/import/SmvImport.cs b/src/BizHawk.Client.Common/movie/import/SmvImport.cs
@@ -189,7 +189,7 @@ is used (and MOVIE_SYNC_DATA_EXISTS is set), 0 bytes otherwise.
 			}
 
 			ControllerDefinition definition = new Snes9xControllers(ss).ControllerDefinition;
-			definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+			definition.BuildMnemonicsCache(Result.Movie.SystemID);
 			SimpleController controllers = new(definition);
 
 			Result.Movie.LogKey = Bk2LogEntryGenerator.GenerateLogKey(definition);
diff --git a/src/BizHawk.Client.Common/movie/import/VbmImport.cs b/src/BizHawk.Client.Common/movie/import/VbmImport.cs
@@ -203,7 +203,7 @@ recording time in Unix epoch format
 			SimpleController controllers = isGBA
 				? GbaController()
 				: GbController();
-			controllers.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(isGBA ? VSystemID.Raw.GBA : VSystemID.Raw.GB));
+			controllers.Definition.BuildMnemonicsCache(isGBA ? VSystemID.Raw.GBA : VSystemID.Raw.GB);
 
 			/*
 			 * 01 00 A
diff --git a/src/BizHawk.Client.Common/movie/import/YmvImport.cs b/src/BizHawk.Client.Common/movie/import/YmvImport.cs
@@ -106,7 +106,7 @@ private void ImportTextFrame(string line)
 					"Reset", "Power", "Previous Disk", "Next Disk", "P1 Left", "P1 Right", "P1 Up", "P1 Down", "P1 Start", "P1 A", "P1 B", "P1 C", "P1 X", "P1 Y", "P1 Z", "P1 L", "P1 R"
 				}
 			}.MakeImmutable());
-			controllers.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));
+			controllers.Definition.BuildMnemonicsCache(Result.Movie.SystemID);
 
 			// Split up the sections of the frame.
 			var sections = line.Split(new[] { "|" }, StringSplitOptions.RemoveEmptyEntries);
diff --git a/src/BizHawk.Client.Common/movie/import/bkm/BkmControllerAdapter.cs b/src/BizHawk.Client.Common/movie/import/bkm/BkmControllerAdapter.cs
@@ -32,7 +32,7 @@ public BkmControllerAdapter(ControllerDefinition definition, string systemId)
 				_ => "Null Controller",
 			};
 			Definition = new(copyFrom: definition, withName: name);
-			Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(systemId));
+			Definition.BuildMnemonicsCache(systemId); //TODO these aren't the same...
 		}
 
 		public ControllerDefinition Definition { get; set; }
diff --git a/src/BizHawk.Emulation.Common/Base Implementations/Bk2MnemonicLookup.cs b/src/BizHawk.Emulation.Common/Base Implementations/Bk2MnemonicLookup.cs
@@ -1,12 +1,13 @@
 ﻿using System.Collections.Generic;
 using BizHawk.Common.StringExtensions;
-using BizHawk.Emulation.Common;
-using BizHawk.Emulation.Cores.Libretro;
 
-namespace BizHawk.Client.Common
+namespace BizHawk.Emulation.Common
 {
 	public static class Bk2MnemonicLookup
 	{
+		/// <remarks>duplicated with <c>LibretroControllerDef</c></remarks>
+		private const string PFX_RETROPAD = "RetroPad ";
+
 		public static char Lookup(string button, string systemId)
 		{
 			var key = button.Replace("Key ", "");
@@ -21,7 +22,7 @@ public static char Lookup(string button, string systemId)
 					key = key.Substring(3);
 				}
 			}
-			key = key.RemovePrefix(LibretroHost.LibretroControllerDef.PFX_RETROPAD);
+			key = key.RemovePrefix(PFX_RETROPAD);
 
 			if (SystemOverrides.TryGetValue(systemId, out var overridesForSys) && overridesForSys.TryGetValue(key, out var c))
 			{
@@ -63,8 +64,6 @@ public static string LookupAxis(string button, string systemId)
 			return button;
 		}
 
-		public static Func<string, char> MnemonicFunc(string systemId) => buttonName => Lookup(buttonName, systemId);
-
 		private static readonly Dictionary<string, char> BaseMnemonicLookupTable = new Dictionary<string, char>
 		{
 			["Power"] = 'P',
diff --git a/src/BizHawk.Emulation.Common/Base Implementations/ControllerDefinition.cs b/src/BizHawk.Emulation.Common/Base Implementations/ControllerDefinition.cs
@@ -40,14 +40,15 @@ public class ControllerDefinition
 
 		/// <remarks>
 		/// TODO: this should probably be called in <see cref="MakeImmutable"/>,
-		/// but the needed Bk2MnemonicsLookup is in Client.Common
 		/// </remarks>
-		public void BuildMnemonicsCache(Func<string, char> mnemonicFunc)
+		public void BuildMnemonicsCache(string sysID)
 		{
 			if (_mutable)
 				throw new InvalidOperationException($"this {nameof(ControllerDefinition)} has not yet been built and sealed; can't build mnemonics cache");
 
-			_mnemonicsCache ??= BoolButtons.ToDictionary(buttonName => buttonName, mnemonicFunc);
+			_mnemonicsCache ??= BoolButtons.ToDictionary(
+				static buttonName => buttonName,
+				buttonName => Bk2MnemonicLookup.Lookup(buttonName, sysID));
 		}
 
 		public ControllerDefinition(string name)
diff --git a/src/BizHawk.Emulation.Cores/Libretro/Libretro.IEmulator.cs b/src/BizHawk.Emulation.Cores/Libretro/Libretro.IEmulator.cs
@@ -74,7 +74,7 @@ public class LibretroControllerDef : ControllerDefinition
 		{
 			private const string CAT_KEYBOARD = "RetroKeyboard";
 
-			public const string PFX_RETROPAD = "RetroPad ";
+			private const string PFX_RETROPAD = "RetroPad ";
 
 			public LibretroControllerDef()
 				: base(name: "LibRetro Controls"/*for compatibility*/)
diff --git a/src/BizHawk.Tests/Client.Common/Display/InputDisplayTests.cs b/src/BizHawk.Tests/Client.Common/Display/InputDisplayTests.cs
@@ -15,12 +15,12 @@ public class InputDisplayTests
 		public void Initializer()
 		{
 			_boolController = new(new ControllerDefinition("Dummy Gamepad") { BoolButtons = { "A" } }.MakeImmutable());
-			_boolController.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(VSystemID.Raw.NULL));
+			_boolController.Definition.BuildMnemonicsCache(VSystemID.Raw.NULL);
 			_axisController = new(
 				new ControllerDefinition("Dummy Gamepad")
 					.AddXYPair("Stick{0}", AxisPairOrientation.RightAndUp, 0.RangeTo(200), MidValue)
 					.MakeImmutable());
-			_axisController.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(VSystemID.Raw.NULL));
+			_axisController.Definition.BuildMnemonicsCache(VSystemID.Raw.NULL);
 		}
 
 		[TestMethod]
diff --git a/src/BizHawk.Tests/Client.Common/Movie/LogGeneratorTests.cs b/src/BizHawk.Tests/Client.Common/Movie/LogGeneratorTests.cs
@@ -14,19 +14,19 @@ public class LogGeneratorTests
 		public void Initializer()
 		{
 			_boolController = new(new ControllerDefinition("Dummy Gamepad") { BoolButtons = { "A" } }.MakeImmutable());
-			_boolController.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(VSystemID.Raw.NES));
+			_boolController.Definition.BuildMnemonicsCache(VSystemID.Raw.NES);
 			_axisController = new(
 				new ControllerDefinition("Dummy Gamepad")
 					.AddXYPair("Stick{0}", AxisPairOrientation.RightAndUp, 0.RangeTo(200), 100)
 					.MakeImmutable());
-			_axisController.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(VSystemID.Raw.NES));
+			_axisController.Definition.BuildMnemonicsCache(VSystemID.Raw.NES);
 		}
 
 		[TestMethod]
 		public void GenerateLogEntry_ExclamationForUnknownButtons()
 		{
 			SimpleController controller = new(new ControllerDefinition("Dummy Gamepad") { BoolButtons = { "Unknown Button" } }.MakeImmutable());
-			controller.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(VSystemID.Raw.NES));
+			controller.Definition.BuildMnemonicsCache(VSystemID.Raw.NES);
 			controller["Unknown Button"] = true;
 			var actual = Bk2LogEntryGenerator.GenerateLogEntry(controller);
 			Assert.AreEqual("|!|", actual);

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public class InputManager`
`52`	`52`	`public void SyncControls(IEmulator emulator, IMovieSession session, Config config)`
`53`	`53`	`{`
`54`	`54`	`var def = emulator.ControllerDefinition;`
`55`		`- def.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(emulator.SystemId));`
	`55`	`+ def.BuildMnemonicsCache(emulator.SystemId);`
`56`	`56`
`57`	`57`	`ActiveController = BindToDefinition(def, config.AllTrollers, config.AllTrollersAnalog, config.AllTrollersFeedbacks);`
`58`	`58`	`AutoFireController = BindToDefinitionAF(emulator, config.AllTrollersAutoFire, config.AutofireOn, config.AutofireOff);`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ protected override void RunImport()`
`93`	`93`
`94`	`94`	`private void ImportInputFrame(string line)`
`95`	`95`	`{`
`96`		`- DeSmuMEControllerDef.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));`
	`96`	`+ DeSmuMEControllerDef.BuildMnemonicsCache(Result.Movie.SystemID);`
`97`	`97`	`SimpleController controller = new(DeSmuMEControllerDef);`
`98`	`98`
`99`	`99`	`controller["LidOpen"] = false;`
Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ protected override void RunImport()`
`119`	`119`	`{`
`120`	`120`	`controllerSettings.NesLeftPort = nameof(ControllerNES);`
`121`	`121`	`_deck = controllerSettings.Instantiate((_, _) => false).AddSystemToControllerDef();`
`122`		`- _deck.ControllerDef.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));`
	`122`	`+ _deck.ControllerDef.BuildMnemonicsCache(Result.Movie.SystemID);`
`123`	`123`	`}`
`124`	`124`	`}`
`125`	`125`	`else if (line.StartsWith("port1", StringComparison.OrdinalIgnoreCase))`
`@@ -128,7 +128,7 @@ protected override void RunImport()`
`128`	`128`	`{`
`129`	`129`	`controllerSettings.NesRightPort = nameof(ControllerNES);`
`130`	`130`	`_deck = controllerSettings.Instantiate((_, _) => false).AddSystemToControllerDef();`
`131`		`- _deck.ControllerDef.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));`
	`131`	`+ _deck.ControllerDef.BuildMnemonicsCache(Result.Movie.SystemID);`
`132`	`132`	`}`
`133`	`133`	`}`
`134`	`134`	`else if (line.StartsWith("port2", StringComparison.OrdinalIgnoreCase))`
`@@ -147,7 +147,7 @@ protected override void RunImport()`
`147`	`147`	`controllerSettings.NesLeftPort = nameof(FourScore);`
`148`	`148`	`controllerSettings.NesRightPort = nameof(FourScore);`
`149`	`149`	`_deck = controllerSettings.Instantiate((_, _) => false).AddSystemToControllerDef();`
`150`		`- _deck.ControllerDef.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));`
	`150`	`+ _deck.ControllerDef.BuildMnemonicsCache(Result.Movie.SystemID);`
`151`	`151`	`}`
`152`	`152`	`}`
`153`	`153`	`else`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ protected override void RunImport()`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`ControllerDefinition controllerDefinition = new BsnesControllers(ss, true).Definition;`
`87`		`- controllerDefinition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(VSystemID.Raw.SNES));`
	`87`	`+ controllerDefinition.BuildMnemonicsCache(VSystemID.Raw.SNES);`
`88`	`88`	`_emptyController = new SimpleController(controllerDefinition);`
`89`	`89`	`_controller = new SimpleController(controllerDefinition);`
`90`	`90`	`_playerCount = controllerDefinition.PlayerCount;`
Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,7 @@ private void ImportTextFrame(string line)`
`146`	`146`	`{`
`147`	`147`	`var buttons = new[] { "Up", "Down", "Left", "Right", "B1", "B2", "Run", "Select" };`
`148`	`148`
`149`		`- _deck.Definition.BuildMnemonicsCache(Bk2MnemonicLookup.MnemonicFunc(Result.Movie.SystemID));`
	`149`	`+ _deck.Definition.BuildMnemonicsCache(Result.Movie.SystemID);`
`150`	`150`	`SimpleController controllers = new(_deck.Definition);`
`151`	`151`
`152`	`152`	`// Split up the sections of the frame.`