Allow `ControllerDefinition`s to be made immutable

src/BizHawk.Client.Common/movie/import/DsmImport.cs

@@ -16,7 +16,8 @@ namespace BizHawk.Client.Common
 			BoolButtons = { "Up", "Down", "Left", "Right", "Start", "Select", "B", "A", "Y", "X", "L", "R", "LidOpen", "LidClose", "Touch", "Power" },
 		}.AddXYPair("Touch {0}", AxisPairOrientation.RightAndUp, 0.RangeTo(255), 128, 0.RangeTo(191), 96) //TODO verify direction against hardware
 			.AddAxis("Mic Input", 0.RangeTo(2047), 0)
-			.AddAxis("GBA Light Sensor", 0.RangeTo(10), 0);
+			.AddAxis("GBA Light Sensor", 0.RangeTo(10), 0)
+			.MakeImmutable();
 
 		protected override void RunImport()
 		{

src/BizHawk.Client.Common/movie/import/Fm2Import.cs

@@ -269,6 +269,7 @@ namespace BizHawk.Client.Common
 			//TODO FDS
 			def.BoolButtons.Add("Reset");
 			def.BoolButtons.Add("Power");
+			def.MakeImmutable();
 			return deck;
 		}
 	}

src/BizHawk.Client.Common/movie/import/VbmImport.cs

@@ -299,7 +299,7 @@ namespace BizHawk.Client.Common.movie.import
 			=> new(new ControllerDefinition("Gameboy Controller")
 			{
 				BoolButtons = { "Up", "Down", "Left", "Right", "Start", "Select", "B", "A", "Power" }
-			});
+			}.MakeImmutable());
 
 		private static SimpleController GbaController()
 			=> new(MGBAHawk.GBAController);

src/BizHawk.Client.Common/movie/import/YmvImport.cs

@@ -106,7 +106,7 @@ namespace BizHawk.Client.Common.movie.import
 				{
 					"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());
 
 			// Split up the sections of the frame.
 			var sections = line.Split(new[] { "|" }, StringSplitOptions.RemoveEmptyEntries);

src/BizHawk.Client.EmuHawk/MainForm.cs

@@ -2104,7 +2104,7 @@ namespace BizHawk.Client.EmuHawk
 			Controller controls = new(new ControllerDefinition("Emulator Frontend Controls")
 			{
 				BoolButtons = Config.HotkeyBindings.Select(static x => x.DisplayName).ToList(),
-			});
+			}.MakeImmutable());
 
 			foreach (var b in Config.HotkeyBindings)
 			{

src/BizHawk.Client.EmuHawk/config/ControllerConfig.cs

@@ -101,8 +101,8 @@ namespace BizHawk.Client.EmuHawk
 		private void LoadToPanel<TBindValue>(
 			Control dest,
 			string controllerName,
-			IReadOnlyCollection<string> controllerButtons,
+			IList<string> controllerButtons,
-			Dictionary<string,string> categoryLabels,
+			IDictionary<string, string> categoryLabels,
 			IDictionary<string, Dictionary<string, TBindValue>> settingsBlock,
 			TBindValue defaultValue,
 			PanelCreator<TBindValue> createPanel

src/BizHawk.Client.EmuHawk/tools/Macros/MovieZone.cs

@@ -85,7 +85,7 @@ namespace BizHawk.Client.EmuHawk
 				}
 			}
 
-			_controller = _movieSession.GenerateMovieController(d);
+			_controller = _movieSession.GenerateMovieController(d.MakeImmutable());
 		}
 
 		public string Name { get; set; }
@@ -118,7 +118,7 @@ namespace BizHawk.Client.EmuHawk
 				}
 			}
 
-			var newController = _movieSession.GenerateMovieController(d);
+			var newController = _movieSession.GenerateMovieController(d.MakeImmutable());
 			var logGenerator = _movieSession.Movie.LogGeneratorInstance(newController);
 			logGenerator.GenerateLogEntry(); // Reference and create all buttons.
 

src/BizHawk.Emulation.Common/Base Implementations/Axes/AxisDict.cs

@@ -1,13 +1,17 @@
+using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Collections.Immutable;
 
 namespace BizHawk.Emulation.Common
 {
 	public sealed class AxisDict : IReadOnlyDictionary<string, AxisSpec>
 	{
-		private readonly IList<string> _keys = new List<string>();
+		private IList<string> _keys = new List<string>();
 
-		private readonly IDictionary<string, AxisSpec> _specs = new Dictionary<string, AxisSpec>();
+		private bool _mutable = true;
+
+		private IDictionary<string, AxisSpec> _specs = new Dictionary<string, AxisSpec>();
 
 		public int Count => _keys.Count;
 
@@ -22,11 +26,16 @@ namespace BizHawk.Emulation.Common
 		public AxisSpec this[string index]
 		{
 			get => _specs[index];
-			set => _specs[index] = value;
+			set
+			{
+				AssertMutable();
+				_specs[index] = value;
+			}
 		}
 
 		public void Add(string key, AxisSpec value)
 		{
+			AssertMutable();
 			_keys.Add(key);
 			_specs.Add(key, value);
 			if (value.Constraint != null) HasContraints = true;
@@ -34,8 +43,15 @@ namespace BizHawk.Emulation.Common
 
 		public void Add(KeyValuePair<string, AxisSpec> item) => Add(item.Key, item.Value);
 
+		private void AssertMutable()
+		{
+			const string ERR_MSG = "this " + nameof(AxisDict) + " has been built and sealed and may not be mutated";
+			if (!_mutable) throw new InvalidOperationException(ERR_MSG);
+		}
+
 		public void Clear()
 		{
+			AssertMutable();
 			_keys.Clear();
 			_specs.Clear();
 			HasContraints = false;
@@ -49,6 +65,13 @@ namespace BizHawk.Emulation.Common
 
 		public int IndexOf(string key) => _keys.IndexOf(key);
 
+		public void MakeImmutable()
+		{
+			_mutable = false;
+			_keys = _keys.ToImmutableList();
+			_specs = _specs.ToImmutableDictionary();
+		}
+
 		public AxisSpec SpecAtIndex(int index) => this[_keys[index]];
 
 		public bool TryGetValue(string key, out AxisSpec value) => _specs.TryGetValue(key, out value);

src/BizHawk.Emulation.Common/Base Implementations/ControllerDefinition.cs

@@ -1,10 +1,13 @@
 #nullable disable
 
+using System;
 using System.Collections.Generic;
+using System.Collections.Immutable;
 using System.Linq;
 using System.Text.RegularExpressions;
 
 using BizHawk.Common;
+using BizHawk.Common.CollectionExtensions;
 
 namespace BizHawk.Emulation.Common
 {
@@ -14,6 +17,10 @@ namespace BizHawk.Emulation.Common
 	/// <seealso cref="IEmulator" />
 	public class ControllerDefinition
 	{
+		private IList<string> _buttons = new List<string>();
+
+		private bool _mutable = true;
+
 		public readonly string Name;
 
 		public ControllerDefinition(string name)
@@ -26,22 +33,31 @@ namespace BizHawk.Emulation.Common
 			foreach (var kvp in copyFrom.Axes) Axes.Add(kvp);
 			HapticsChannels.AddRange(copyFrom.HapticsChannels);
 			CategoryLabels = copyFrom.CategoryLabels;
+			MakeImmutable();
 		}
 
 		/// <summary>
 		/// Gets or sets a list of all button types that have a boolean (on/off) value
 		/// </summary>
-		public List<string> BoolButtons { get; set; } = new List<string>();
+		public IList<string> BoolButtons
+		{
+			get => _buttons;
+			set
+			{
+				AssertMutable();
+				_buttons = value;
+			}
+		}
 
 		public readonly AxisDict Axes = new AxisDict();
 
 		/// <summary>Contains names of virtual haptic feedback channels, e.g. <c>{ "P1 Mono" }</c>, <c>{ "P2 Left", "P2 Right" }</c>.</summary>
-		public List<string> HapticsChannels { get; } = new();
+		public IList<string> HapticsChannels { get; private set; } = new List<string>();
 
 		/// <summary>
 		/// Gets the category labels. These labels provide a means of categorizing controls in various controller display and config screens
 		/// </summary>
-		public Dictionary<string, string> CategoryLabels { get; } = new Dictionary<string, string>();
+		public IDictionary<string, string> CategoryLabels { get; private set; } = new Dictionary<string, string>();
 
 		public void ApplyAxisConstraints(string constraintClass, IDictionary<string, int> axes)
 		{
@@ -88,6 +104,23 @@ namespace BizHawk.Emulation.Common
 			}
 		}
 
+		private void AssertMutable()
+		{
+			const string ERR_MSG = "this " + nameof(ControllerDefinition) + " has been built and sealed, and may not be mutated";
+			if (!_mutable) throw new InvalidOperationException(ERR_MSG);
+		}
+
+		/// <summary>permanently disables the ability to mutate this instance; returns this reference</summary>
+		public ControllerDefinition MakeImmutable()
+		{
+			BoolButtons = BoolButtons.ToImmutableList();
+			Axes.MakeImmutable();
+			HapticsChannels = HapticsChannels.ToImmutableList();
+			CategoryLabels = CategoryLabels.ToImmutableDictionary();
+			_mutable = false;
+			return this;
+		}
+
 		public int PlayerNumber(string buttonName)
 		{
 			var match = PlayerRegex.Match(buttonName);

src/BizHawk.Emulation.Common/Base Implementations/NullController.cs

@@ -12,7 +12,7 @@ namespace BizHawk.Emulation.Common
 	/// <seealso cref="IController" />
 	public class NullController : IController
 	{
-		public ControllerDefinition Definition { get; } = new ControllerDefinition("Null Controller");
+		public ControllerDefinition Definition { get; } = new ControllerDefinition("Null Controller").MakeImmutable();
 
 		public bool IsPressed(string button) => false;
 

src/BizHawk.Emulation.Common/BizHawk.Emulation.Common.csproj

@@ -7,6 +7,7 @@
 		<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 	</PropertyGroup>
 	<ItemGroup>
+		<PackageReference Include="System.Collections.Immutable" Version="6.0.0" />
 		<PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
 		<ProjectReference Include="$(ProjectDir)../BizHawk.BizInvoke/BizHawk.BizInvoke.csproj" />
 		<ProjectReference Include="$(ProjectDir)../BizHawk.Common/BizHawk.Common.csproj" />

src/BizHawk.Emulation.Cores/Arcades/MAME/MAME.IInputPollable.cs

@@ -23,6 +23,7 @@ namespace BizHawk.Emulation.Cores.Arcades.MAME
 		{
 			string inputFields = MameGetString(MAMELuaCommand.GetInputFields);
 			string[] portFields = inputFields.Split(';');
+			MAMEController = new("MAME Controller");
 			MAMEController.BoolButtons.Clear();
 			_fieldsPorts.Clear();
 
@@ -38,6 +39,8 @@ namespace BizHawk.Emulation.Cores.Arcades.MAME
 					MAMEController.BoolButtons.Add(field);
 				}
 			}
+
+			MAMEController.MakeImmutable();
 		}
 
 		private void SendInput()

src/BizHawk.Emulation.Cores/Calculator/TI83.cs

@@ -90,7 +90,7 @@ namespace BizHawk.Emulation.Cores.Calculators
 				"STO", "LN", "LOG", "SQUARED", "NEG1", "MATH", "ALPHA",
 				"GRAPH", "TRACE", "ZOOM", "WINDOW", "Y", "2ND", "MODE", "DEL",
 			},
-		};
+		}.MakeImmutable();
 
 		private byte ReadMemory(ushort addr)
 		{

src/BizHawk.Emulation.Cores/Computers/AmstradCPC/AmstradCPC.Controllers.cs

@@ -111,7 +111,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 					definition.CategoryLabels[s] = "Amstrad Disk Drive";
 				}
 
-				return definition;
+				return definition.MakeImmutable();
 			}
 		}
 	}

src/BizHawk.Emulation.Cores/Computers/AppleII/AppleII.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Linq;
 
+using BizHawk.Common.CollectionExtensions;
 using BizHawk.Emulation.Common;
 using Jellyfish.Virtu;
 
@@ -15,6 +16,7 @@ namespace BizHawk.Emulation.Cores.Computers.AppleII
 			AppleIIController = new("Apple IIe Keyboard");
 			AppleIIController.BoolButtons.AddRange(RealButtons);
 			AppleIIController.BoolButtons.AddRange(ExtraButtons);
+			AppleIIController.MakeImmutable();
 		}
 
 		[CoreConstructor(VSystemID.Raw.AppleII)]

src/BizHawk.Emulation.Cores/Computers/Commodore64/C64.cs

@@ -150,7 +150,7 @@ namespace BizHawk.Emulation.Cores.Computers.Commodore64
 				"Previous Disk", "Next Disk",
 				"Power", "Reset"
 			}
-		};
+		}.MakeImmutable();
 
 		private Motherboard _board;
 

src/BizHawk.Emulation.Cores/Computers/MSX/MSX.Input.cs

@@ -22,7 +22,7 @@ namespace BizHawk.Emulation.Cores.Computers.MSX
 					"RET", "SEL", "BACK", "STOP", "TAB", "ESC", "F5", "F4",
 					"RIGHT", "DOWN", "UP", "LEFT", "DEL", "INS", "HOME", "SPACE"
 				}
-		};
+		}.MakeImmutable();
 
 		public static readonly ControllerDefinition MSXControllerJS = new ControllerDefinition("MSX Controller Joystick")
 		{
@@ -32,6 +32,6 @@ namespace BizHawk.Emulation.Cores.Computers.MSX
 					"P1 Up", "P1 Down", "P1 Left", "P1 Right", "P1 B1", "P1 B2",
 					"P2 Up", "P2 Down", "P2 Left", "P2 Right", "P2 B1", "P2 B2"
 				}
-		};
+		}.MakeImmutable();
 	}
 }

src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/ZXSpectrum.Controllers.cs

@@ -120,7 +120,7 @@ namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
 					definition.CategoryLabels[s] = "+3 Disk Drive";
 				}
 
-				return definition;
+				return definition.MakeImmutable();
 			}
 		}
 	}

src/BizHawk.Emulation.Cores/Consoles/Atari/2600/Atari2600ControllerDeck.cs

@@ -28,6 +28,8 @@ namespace BizHawk.Emulation.Cores.Atari.Atari2600
 
 			foreach (var kvp in Port1.Definition.Axes) Definition.Axes.Add(kvp);
 			foreach (var kvp in Port2.Definition.Axes) Definition.Axes.Add(kvp);
+
+			Definition.MakeImmutable();
 		}
 
 		public byte ReadPort1(IController c)

src/BizHawk.Emulation.Cores/Consoles/Atari/2600/Atari2600Controllers.cs

@@ -117,7 +117,8 @@ namespace BizHawk.Emulation.Cores.Atari.Atari2600
 				.Select(b => $"P{PortNum} " + b)
 				.ToList()
 			}.AddAxis($"P{PortNum} Paddle X 1", (-127).RangeTo(127), 0)
-				.AddAxis($"P{PortNum} Paddle X 2", (-127).RangeTo(127), 0);
+				.AddAxis($"P{PortNum} Paddle X 2", (-127).RangeTo(127), 0)
+				.MakeImmutable();
 		}
 
 		public int PortNum { get; }
@@ -233,7 +234,8 @@ namespace BizHawk.Emulation.Cores.Atari.Atari2600
 				.Select(b => $"P{PortNum} " + b)
 				.ToList()
 			}.AddAxis($"P{PortNum} Wheel X 1", (-127).RangeTo(127), 0)
-				.AddAxis($"P{PortNum} Wheel X 2", (-127).RangeTo(127), 0);
+				.AddAxis($"P{PortNum} Wheel X 2", (-127).RangeTo(127), 0)
+				.MakeImmutable();
 		}
 
 		public int PortNum { get; }

src/BizHawk.Emulation.Cores/Consoles/Atari/A7800Hawk/A7800HawkControllerDeck.cs

@@ -38,6 +38,8 @@ namespace BizHawk.Emulation.Cores.Atari.A7800Hawk
 
 			foreach (var kvp in Port1.Definition.Axes) Definition.Axes.Add(kvp);
 			foreach (var kvp in Port2.Definition.Axes) Definition.Axes.Add(kvp);
+
+			Definition.MakeImmutable();
 		}
 
 		public byte ReadPort1(IController c)

src/BizHawk.Emulation.Cores/Consoles/Atari/lynx/Lynx.cs

@@ -164,7 +164,7 @@ namespace BizHawk.Emulation.Cores.Atari.Lynx
 		private static readonly ControllerDefinition LynxTroller = new ControllerDefinition("Lynx Controller")
 		{
 			BoolButtons = { "Up", "Down", "Left", "Right", "A", "B", "Option 1", "Option 2", "Pause", "Power" },
-		};
+		}.MakeImmutable();
 
 		public ControllerDefinition ControllerDefinition => LynxTroller;
 

src/BizHawk.Emulation.Cores/Consoles/Belogic/Uzem.cs

@@ -55,12 +55,13 @@ namespace BizHawk.Emulation.Cores.Consoles.Belogic
 				"P2 Up", "P2 Down", "P2 Left", "P2 Right", "P2 Select", "P2 Start", "P2 X", "P2 A", "P2 B", "P2 Y", "P2 L", "P2 R",
 				"Power"
 			}
-		};
+		}.MakeImmutable();
 
 		private static readonly ControllerDefinition Mouse = new ControllerDefinition("SNES Controller")
 		{
 			BoolButtons = { "P1 Mouse Left", "P1 Mouse Right", "Power" }
-		}.AddXYPair("P1 Mouse {0}", AxisPairOrientation.RightAndUp, (-127).RangeTo(127), 0); //TODO verify direction against hardware
+		}.AddXYPair("P1 Mouse {0}", AxisPairOrientation.RightAndUp, (-127).RangeTo(127), 0) //TODO verify direction against hardware
+			.MakeImmutable();
 
 		private static readonly string[] PadBits =
 		{

src/BizHawk.Emulation.Cores/Consoles/Coleco/ColecoControllerDeck.cs

@@ -32,6 +32,8 @@ namespace BizHawk.Emulation.Cores.ColecoVision
 
 			foreach (var kvp in Port1.Definition.Axes) Definition.Axes.Add(kvp);
 			foreach (var kvp in Port2.Definition.Axes) Definition.Axes.Add(kvp);
+
+			Definition.MakeImmutable();
 		}
 
 		public float wheel1;

src/BizHawk.Emulation.Cores/Consoles/Fairchild/ChannelF/ChannelF.Controllers.cs

@@ -52,7 +52,7 @@ namespace BizHawk.Emulation.Cores.Consoles.ChannelF
 					definition.CategoryLabels[s] = "Console";
 				}
 
-				return definition;
+				return definition.MakeImmutable();
 			}
 		}
 

src/BizHawk.Emulation.Cores/Consoles/GCE/Vectrex/VectrexHawkControllerDeck.cs

@@ -33,6 +33,8 @@ namespace BizHawk.Emulation.Cores.Consoles.Vectrex
 
 			foreach (var kvp in Port1.Definition.Axes) Definition.Axes.Add(kvp);
 			foreach (var kvp in Port2.Definition.Axes) Definition.Axes.Add(kvp);
+
+			Definition.MakeImmutable();
 		}
 
 		public byte ReadPort1(IController c)

src/BizHawk.Emulation.Cores/Consoles/Intellivision/Controllers/IntellivisionControllerDeck.cs

@@ -33,6 +33,8 @@ namespace BizHawk.Emulation.Cores.Intellivision
 
 			foreach (var kvp in Port1.Definition.Axes) Definition.Axes.Add(kvp);
 			foreach (var kvp in Port2.Definition.Axes) Definition.Axes.Add(kvp);
+
+			Definition.MakeImmutable();
 		}
 
 		public byte ReadPort1(IController c)

src/BizHawk.Emulation.Cores/Consoles/Magnavox/Odyssey2/O2HawkControllerDeck.cs

@@ -60,6 +60,8 @@ namespace BizHawk.Emulation.Cores.Consoles.O2Hawk
 			}
 
 			foreach (var kvp in Port1.Definition.Axes) Definition.Axes.Add(kvp);
+
+			Definition.MakeImmutable();
 		}
 
 		public byte ReadPort1(IController c)

src/BizHawk.Emulation.Cores/Consoles/Nintendo/BSNES/BsnesControllers.cs

@@ -52,6 +52,8 @@ namespace BizHawk.Emulation.Cores.Nintendo.BSNES
 			// add buttons that the core itself will handle
 			Definition.BoolButtons.Add("Reset");
 			Definition.BoolButtons.Add("Power");
+
+			Definition.MakeImmutable();
 		}
 
 		public void CoreInputPoll(IController controller)

src/BizHawk.Emulation.Cores/Consoles/Nintendo/GBA/MGBAHawk.cs

@@ -265,6 +265,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.GBA
 		{
 			BoolButtons = { "Up", "Down", "Left", "Right", "Start", "Select", "B", "A", "L", "R", "Power" }
 		}.AddXYZTriple("Tilt {0}", (-32767).RangeTo(32767), 0)
-			.AddAxis("Light Sensor", 0.RangeTo(255), 0);
+			.AddAxis("Light Sensor", 0.RangeTo(255), 0)
+			.MakeImmutable();
 	}
 }

src/BizHawk.Emulation.Cores/Consoles/Nintendo/GBHawk/GBHawkControllerDeck.cs

@@ -23,6 +23,8 @@ namespace BizHawk.Emulation.Cores.Nintendo.GBHawk
 			};
 
 			foreach (var kvp in Port1.Definition.Axes) Definition.Axes.Add(kvp);
+
+			Definition.MakeImmutable();
 		}
 
 		public byte ReadPort1(IController c)

src/BizHawk.Emulation.Cores/Consoles/Nintendo/GBHawkLink/GBHawkLinkControllerDeck.cs

@@ -24,7 +24,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.GBHawkLink
 					.Concat(Port2.Definition.BoolButtons)
 					.Concat(new[] { "Toggle Cable" } )
 					.ToList()
-			};
+			}.MakeImmutable();
 		}
 
 		public byte ReadPort1(IController c)

src/BizHawk.Emulation.Cores/Consoles/Nintendo/GBHawkLink3x/GBHawkLink3xControllerDeck.cs

@@ -30,7 +30,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.GBHawkLink3x
 					.Concat(new[] { "Toggle Cable CR" } )
 					.Concat(new[] { "Toggle Cable RL" } )
 					.ToList()
-			};
+			}.MakeImmutable();
 		}
 
 		public byte ReadPort1(IController c)

src/BizHawk.Emulation.Cores/Consoles/Nintendo/GBHawkLink4x/GBHawkLink4xControllerDeck.cs

@@ -35,7 +35,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.GBHawkLink4x
 					.Concat(new[] { "Toggle Cable X" } )
 					.Concat(new[] { "Toggle Cable 4x" })
 					.ToList()
-			};
+			}.MakeImmutable();
 		}
 
 		public byte ReadPort1(IController c)

src/BizHawk.Emulation.Cores/Consoles/Nintendo/Gameboy/Gambatte.cs

@@ -3,6 +3,7 @@ using System.Collections.Generic;
 using System.Linq;
 
 using BizHawk.Common;
+using BizHawk.Common.CollectionExtensions;
 using BizHawk.Emulation.Common;
 using BizHawk.Emulation.Cores.Consoles.Nintendo.Gameboy;
 
@@ -281,7 +282,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.Gameboy
 			{
 				ret.BoolButtons.AddRange(new[] { "Up", "Down", "Left", "Right", "Start", "Select", "B", "A", "Power" });
 			}
-			return ret;
+			return ret.MakeImmutable();
 		}
 
 		private LibGambatte.Buttons ControllerCallback()

src/BizHawk.Emulation.Cores/Consoles/Nintendo/Gameboy/GambatteLink.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Linq;
 
+using BizHawk.Common.CollectionExtensions;
 using BizHawk.Emulation.Common;
 
 namespace BizHawk.Emulation.Cores.Nintendo.Gameboy
@@ -153,7 +154,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.Gameboy
 				ret.BoolButtons.Add("Toggle Link Shift");
 				ret.BoolButtons.Add("Toggle Link Spacing");
 			}
-			return ret;
+			return ret.MakeImmutable();
 		}
 
 		private const int P1 = 0;

src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64.ISettable.cs

@@ -1,4 +1,5 @@
 using BizHawk.Common;
+using BizHawk.Common.CollectionExtensions;
 using BizHawk.Emulation.Common;
 
 namespace BizHawk.Emulation.Cores.Nintendo.N64
@@ -42,9 +43,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64
 				if (hasRumblePak) def.HapticsChannels.Add($"P{player} Rumble Pak");
 			}
 
-			ControllerDefinition.BoolButtons.Clear();
+			ControllerDefinition = new("Nintendo 64 Controller");
-			ControllerDefinition.Axes.Clear();
-
 			ControllerDefinition.BoolButtons.AddRange(new[] { "Reset", "Power" });
 			for (var i = 0; i < 4; i++)
 			{
@@ -56,6 +55,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64
 						syncSettings.Controllers[i].PakType == N64SyncSettings.N64ControllerSettings.N64ControllerPakType.RUMBLE_PAK);
 				}
 			}
+			ControllerDefinition.MakeImmutable();
 		}
 	}
 }

src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64.cs

@@ -246,7 +246,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64
 
 		public DisplayType Region => _display_type;
 
-		public ControllerDefinition ControllerDefinition { get; } = new("Nintendo 64 Controller");
+		public ControllerDefinition ControllerDefinition { get; private set; } = new("Nintendo 64 Controller");
 
 		public void ResetCounters()
 		{

src/BizHawk.Emulation.Cores/Consoles/Nintendo/NDS/MelonDS.cs

@@ -189,7 +189,9 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.NDS
 			}
 		}.AddXYPair("Touch {0}", AxisPairOrientation.RightAndUp, 0.RangeTo(255), 128, 0.RangeTo(191), 96)
 			.AddAxis("Mic Volume", (0).RangeTo(100), 0)
-			.AddAxis("GBA Light Sensor", 0.RangeTo(10), 0);
+			.AddAxis("GBA Light Sensor", 0.RangeTo(10), 0)
+			.MakeImmutable();
+
 		private LibMelonDS.Buttons GetButtons(IController c)
 		{
 			LibMelonDS.Buttons b = 0;

src/BizHawk.Emulation.Cores/Consoles/Nintendo/NES/NES.Core.cs

@@ -177,6 +177,8 @@ namespace BizHawk.Emulation.Cores.Nintendo.NES
 				ControllerDefinition.AddAxis("Reset Cycle", 0.RangeTo(500000), 0);
 			}
 
+			ControllerDefinition.MakeImmutable();
+
 			// don't replace the magicSoundProvider on reset, as it's not needed
 			// if (magicSoundProvider != null) magicSoundProvider.Dispose();
 

src/BizHawk.Emulation.Cores/Consoles/Nintendo/NES/NES.cs

@@ -256,7 +256,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.NES
 					"P1 Up", "P1 Down", "P1 Left", "P1 Right", "P1 Start", "P1 Select", "P1 B", "P1 A", "Reset", "Power",
 					"P2 Up", "P2 Down", "P2 Left", "P2 Right", "P2 Start", "P2 Select", "P2 B", "P2 A"
 				}
-			};
+			}.MakeImmutable();
 
 		public ControllerDefinition ControllerDefinition { get; private set; }
 

src/BizHawk.Emulation.Cores/Consoles/Nintendo/QuickNES/QuickNES.cs

@@ -6,6 +6,7 @@ using System.Linq;
 using System.Runtime.InteropServices;
 
 using BizHawk.Common;
+using BizHawk.Common.CollectionExtensions;
 using BizHawk.Emulation.Common;
 using BizHawk.Emulation.Cores.Nintendo.NES;
 using BizHawk.BizInvoke;
@@ -125,7 +126,7 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.QuickNES
 			if (_syncSettings.LeftPortConnected && _syncSettings.RightPortConnected)
 				def.BoolButtons.AddRange(PadP2.Select(p => p.Name));
 			def.BoolButtons.AddRange(new[] { "Reset", "Power" }); // console buttons
-			ControllerDefinition = def;
+			ControllerDefinition = def.MakeImmutable();
 		}
 
 		private struct PadEnt

src/BizHawk.Emulation.Cores/Consoles/Nintendo/SNES/LibsnesControllerDeck.cs

@@ -69,6 +69,8 @@ namespace BizHawk.Emulation.Cores.Nintendo.SNES
 			// add buttons that the core itself will handle
 			Definition.BoolButtons.Add("Reset");
 			Definition.BoolButtons.Add("Power");
+
+			Definition.MakeImmutable();
 		}
 
 		public void NativeInit(LibsnesApi api)

src/BizHawk.Emulation.Cores/Consoles/Nintendo/SNES9X/Snes9x.cs

@@ -115,6 +115,8 @@ namespace BizHawk.Emulation.Cores.Nintendo.SNES9X
 			// add buttons that the core itself will handle
 			_controllerDefinition.BoolButtons.Add("Reset");
 			_controllerDefinition.BoolButtons.Add("Power");
+
+			_controllerDefinition.MakeImmutable();
 		}
 
 		private void UpdateControls(IController c)

src/BizHawk.Emulation.Cores/Consoles/Nintendo/SubGBHawk/SubGBHawk.cs

@@ -40,7 +40,8 @@ namespace BizHawk.Emulation.Cores.Nintendo.SubGBHawk
 			_tracer = new TraceBuffer(_GBCore.cpu.TraceHeader);
 			ser.Register(_tracer);
 
-			_GBCore.ControllerDefinition.AddAxis("Input Cycle", 0.RangeTo(70224), 70224);
+			_GBCore.ControllerDefinition.AddAxis("Input Cycle", 0.RangeTo(70224), 70224)
+				.MakeImmutable();
 		}
 
 		public GBHawk.GBHawk _GBCore;

src/BizHawk.Emulation.Cores/Consoles/Nintendo/VB/VirtualBoyee.cs

@@ -110,7 +110,7 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.VB
 				.OrderBy(b => _buttonOrdinals[b])
 				.Concat(new[] { "Power" })
 				.ToList()
-		};
+		}.MakeImmutable();
 
 		public override ControllerDefinition ControllerDefinition => VirtualBoyController;
 

src/BizHawk.Emulation.Cores/Consoles/PC Engine/PceControllerDeck.cs

@@ -46,6 +46,7 @@ namespace BizHawk.Emulation.Cores.PCEngine
 			foreach (var kvp in _port3.Definition.Axes) Definition.Axes.Add(kvp);
 			foreach (var kvp in _port4.Definition.Axes) Definition.Axes.Add(kvp);
 			foreach (var kvp in _port5.Definition.Axes) Definition.Axes.Add(kvp);
+			Definition.MakeImmutable();
 		}
 
 		private readonly IPort _port1;

src/BizHawk.Emulation.Cores/Consoles/Sega/GGHawkLink/GGHawkLinkControllerDeck.cs

@@ -25,7 +25,7 @@ namespace BizHawk.Emulation.Cores.Sega.GGHawkLink
 					.Concat(Port2.Definition.BoolButtons)
 					.Concat(new[] { "Toggle Cable" } )
 					.ToList()
-			};
+			}.MakeImmutable();
 		}
 
 		public byte ReadPort1(IController c)

src/BizHawk.Emulation.Cores/Consoles/Sega/PicoDrive/PicoDrive.cs

@@ -131,7 +131,7 @@ namespace BizHawk.Emulation.Cores.Consoles.Sega.PicoDrive
 				"P2 Up", "P2 Down", "P2 Left", "P2 Right", "P2 A", "P2 B", "P2 C", "P2 Start", "P2 X", "P2 Y", "P2 Z", "P2 Mode",
 				"Power", "Reset"
 			}
-		};
+		}.MakeImmutable();
 
 		private static readonly string[] ButtonOrders =
 		{

src/BizHawk.Emulation.Cores/Consoles/Sega/SMS/SMSControllerDeck.cs

@@ -23,7 +23,7 @@ namespace BizHawk.Emulation.Cores.Sega.MasterSystem
 					BoolButtons = new[] { "Reset" }
 							.Concat(Port1.Definition.BoolButtons)
 							.ToList()
-				};
+				}.MakeImmutable();
 			}
 			else
 			{
@@ -38,7 +38,7 @@ namespace BizHawk.Emulation.Cores.Sega.MasterSystem
 								.Concat(Port1.Definition.BoolButtons)
 								.Concat(Port2.Definition.BoolButtons)
 								.ToList()
-					};
+					}.MakeImmutable();
 				}
 				else
 				{
@@ -49,7 +49,7 @@ namespace BizHawk.Emulation.Cores.Sega.MasterSystem
 								.Concat(Port2.Definition.BoolButtons)
 								.Concat(KeyboardMap)
 								.ToList()
-					};
+					}.MakeImmutable();
 				}
 
 				foreach (var kvp in Port1.Definition.Axes) Definition.Axes.Add(kvp);

src/BizHawk.Emulation.Cores/Consoles/Sega/gpgx64/GPGXControlConverter.cs

@@ -235,6 +235,8 @@ namespace BizHawk.Emulation.Cores.Consoles.Sega.gpgx
 						throw new Exception("Unknown Genesis control device!  Something went wrong.");
 				}
 			}
+
+			ControllerDef.MakeImmutable();
 		}
 
 		public void Convert(IController source, LibGPGX.InputData target)

src/BizHawk.Emulation.Cores/Consoles/Sony/PS2/DobieStation.cs

@@ -163,7 +163,7 @@ namespace BizHawk.Emulation.Cores.Sony.PS2
 				{ "LEFT X", new AxisSpec(0.RangeTo(255), 128) },
 				{ "LEFT Y", new AxisSpec(0.RangeTo(255), 128) },
 			}
-		};
+		}.MakeImmutable();
 
 		public class DobieSyncSettings
 		{

src/BizHawk.Emulation.Cores/Consoles/Sony/PSX/Octoshock.cs

@@ -354,7 +354,7 @@ namespace BizHawk.Emulation.Cores.Sony.PSX
 
 			definition.AddAxis("Disc Select", 0.RangeTo(1), 1);
 
-			return definition;
+			return definition.MakeImmutable();
 		}
 
 		private void SetControllerButtons()

src/BizHawk.Emulation.Cores/Consoles/WonderSwan/WonderSwan.Controller.cs

@@ -61,7 +61,8 @@ namespace BizHawk.Emulation.Cores.WonderSwan
 				{ "P2 B", "Rotated" },
 				{ "P2 A", "Rotated" },
 			}
-		};
+		}.MakeImmutable();
+
 		public ControllerDefinition ControllerDefinition => WonderSwanController;
 
 		private BizSwan.Buttons GetButtons(IController controller)

src/BizHawk.Emulation.Cores/Libretro/LibretroCore.cs

@@ -275,7 +275,7 @@ namespace BizHawk.Emulation.Cores.Libretro
 				definition.CategoryLabels[key] = "RetroKeyboard";
 			}
 
-			return definition;
+			return definition.MakeImmutable();
 		}
 
 		public ControllerDefinition ControllerDefinition { get; }

src/BizHawk.Emulation.Cores/Waterbox/NymaCore.Controller.cs

@@ -263,7 +263,7 @@ namespace BizHawk.Emulation.Cores.Waterbox
 					ret.BoolButtons.Add("Previous Disk");
 					ret.BoolButtons.Add("Next Disk");
 				}
-				Definition = ret;
+				Definition = ret.MakeImmutable();
 				finalDevices.Add(null);
 				Devices = finalDevices.ToArray();
 				_switchPreviousFrame = switchPreviousFrame.ToArray();

src/BizHawk.Tests/Client.Common/Display/InputDisplayTests.cs

@@ -16,8 +16,11 @@ namespace BizHawk.Tests.Client.Common.Display
 		[TestInitialize]
 		public void Initializer()
 		{
-			_boolController = new(new ControllerDefinition("Dummy Gamepad") { BoolButtons = { "A" } });
+			_boolController = new(new ControllerDefinition("Dummy Gamepad") { BoolButtons = { "A" } }.MakeImmutable());
-			_axisController = new(new ControllerDefinition("Dummy Gamepad").AddXYPair("Stick{0}", AxisPairOrientation.RightAndUp, 0.RangeTo(200), MidValue));
+			_axisController = new(
+				new ControllerDefinition("Dummy Gamepad")
+					.AddXYPair("Stick{0}", AxisPairOrientation.RightAndUp, 0.RangeTo(200), MidValue)
+					.MakeImmutable());
 		}
 
 		[TestMethod]

src/BizHawk.Tests/Client.Common/Movie/LogGeneratorTests.cs

@@ -15,14 +15,17 @@ namespace BizHawk.Tests.Client.Common.Movie
 		[TestInitialize]
 		public void Initializer()
 		{
-			_boolController = new(new ControllerDefinition("Dummy Gamepad") { BoolButtons = { "A" } });
+			_boolController = new(new ControllerDefinition("Dummy Gamepad") { BoolButtons = { "A" } }.MakeImmutable());
-			_axisController = new(new ControllerDefinition("Dummy Gamepad").AddXYPair("Stick{0}", AxisPairOrientation.RightAndUp, 0.RangeTo(200), 100));
+			_axisController = new(
+				new ControllerDefinition("Dummy Gamepad")
+					.AddXYPair("Stick{0}", AxisPairOrientation.RightAndUp, 0.RangeTo(200), 100)
+					.MakeImmutable());
 		}
 
 		[TestMethod]
 		public void GenerateLogEntry_ExclamationForUnknownButtons()
 		{
-			SimpleController controller = new(new ControllerDefinition("Dummy Gamepad") { BoolButtons = { "Unknown Button" } });
+			SimpleController controller = new(new ControllerDefinition("Dummy Gamepad") { BoolButtons = { "Unknown Button" } }.MakeImmutable());
 			var lg = new Bk2LogEntryGenerator("NES", controller);
 			controller["Unknown Button"] = true;
 			var actual = lg.GenerateLogEntry();