SystemInfo cleanup.

This commit is contained in:
J.D. Purcell 2017-04-17 20:56:21 -04:00
parent 18017b5e23
commit 49134199fc
1 changed files with 39 additions and 103 deletions

View File

@ -14,57 +14,12 @@ namespace BizHawk.Client.Common
private const JoypadButton UpDownLeftRight = JoypadButton.Up | JoypadButton.Down | JoypadButton.Left | JoypadButton.Right; private const JoypadButton UpDownLeftRight = JoypadButton.Up | JoypadButton.Down | JoypadButton.Left | JoypadButton.Right;
private const JoypadButton StandardButtons = JoypadButton.A | JoypadButton.B | JoypadButton.Start | JoypadButton.Select | UpDownLeftRight; private const JoypadButton StandardButtons = JoypadButton.A | JoypadButton.B | JoypadButton.Start | JoypadButton.Select | UpDownLeftRight;
private static readonly List<SystemInfo> allSystemInfos; private static readonly List<SystemInfo> _allSystemInfos = new List<SystemInfo>();
private string _DisplayName;
private CoreSystem _System;
private JoypadButton _AvailableButtons;
private int _MaxControllers;
#endregion #endregion
#region cTor(s) #region cTor(s)
/// <summary>
/// Initializes static members of the <see cref="SystemInfo"/> class.
/// Global initialization stuff
/// </summary>
/// <remarks>
/// DO NOT CHANGE List order because properties depends on it (and it is hardcoded)
/// </remarks>
static SystemInfo()
{
allSystemInfos = new List<SystemInfo>(26)
{
new SystemInfo(string.Empty),
new SystemInfo("NES", CoreSystem.NES, 2, StandardButtons),
new SystemInfo("Intellivision", CoreSystem.Intellivision, 2),
new SystemInfo("Sega Master System", CoreSystem.MasterSystem, 2, UpDownLeftRight | JoypadButton.B1 | JoypadButton.B2),
new SystemInfo("SG-1000", CoreSystem.MasterSystem, 1),
new SystemInfo("Game Gear", CoreSystem.MasterSystem, 1, UpDownLeftRight | JoypadButton.B1 | JoypadButton.B2),
new SystemInfo("TurboGrafx-16", CoreSystem.PCEngine, 1),
new SystemInfo("TurboGrafx - 16(CD)", CoreSystem.PCEngine, 1),
new SystemInfo("SuperGrafx", CoreSystem.PCEngine, 1),
new SystemInfo("Genesis", CoreSystem.Genesis, 2, UpDownLeftRight | JoypadButton.A | JoypadButton.B | JoypadButton.C | JoypadButton.X | JoypadButton.Y | JoypadButton.Z),
new SystemInfo("TI - 83", CoreSystem.TI83, 1),
new SystemInfo("SNES", CoreSystem.SNES, 8, StandardButtons | JoypadButton.X | JoypadButton.Y | JoypadButton.L | JoypadButton.R),
new SystemInfo("GB", CoreSystem.GameBoy, 1, StandardButtons),
new SystemInfo("Gameboy Color", CoreSystem.GameBoy, 1, StandardButtons), // 13 (0 based)
new SystemInfo("Atari 2600", CoreSystem.Atari2600, 1),
new SystemInfo("Atari 7800", CoreSystem.Atari7800, 1),
new SystemInfo("Commodore 64", CoreSystem.Commodore64, 1),
new SystemInfo("ColecoVision", CoreSystem.ColecoVision, 1),
new SystemInfo("Gameboy Advance", CoreSystem.GameBoyAdvance, 1, StandardButtons | JoypadButton.L | JoypadButton.R),
new SystemInfo("Nintendo 64", CoreSystem.Nintendo64, 4, StandardButtons ^ JoypadButton.Select | JoypadButton.Z | JoypadButton.CUp | JoypadButton.CDown | JoypadButton.CLeft | JoypadButton.CRight | JoypadButton.AnalogStick | JoypadButton.L | JoypadButton.R),
new SystemInfo("Saturn", CoreSystem.Saturn, 2, UpDownLeftRight | JoypadButton.A | JoypadButton.B | JoypadButton.C | JoypadButton.X | JoypadButton.Y | JoypadButton.Z),
new SystemInfo("Game Boy Link", CoreSystem.DualGameBoy, 2, StandardButtons),
new SystemInfo("WonderSwan", CoreSystem.WonderSwan, 1),
new SystemInfo("Lynx", CoreSystem.Lynx, 1),
new SystemInfo("PlayStation", CoreSystem.Playstation, 2),
new SystemInfo("Apple II", CoreSystem.AppleII, 1)
};
}
/// <summary> /// <summary>
/// Initialize a new instance of <see cref="SystemInfo"/> /// Initialize a new instance of <see cref="SystemInfo"/>
/// </summary> /// </summary>
@ -72,32 +27,14 @@ namespace BizHawk.Client.Common
/// <param name="system">A <see cref="CoreSystem"/> that specify what core is used</param> /// <param name="system">A <see cref="CoreSystem"/> that specify what core is used</param>
/// <param name="maxControllers">Maximum controller allowed by this system</param> /// <param name="maxControllers">Maximum controller allowed by this system</param>
/// <param name="availableButtons">Which buttons are available (i.e. are actually on the controller) for this system</param> /// <param name="availableButtons">Which buttons are available (i.e. are actually on the controller) for this system</param>
private SystemInfo(string displayName, CoreSystem system, int maxControllers, JoypadButton availableButtons) private SystemInfo(string displayName, CoreSystem system, int maxControllers, JoypadButton availableButtons = 0)
{ {
_DisplayName = displayName; DisplayName = displayName;
_System = system; System = system;
_MaxControllers = maxControllers; MaxControllers = maxControllers;
_AvailableButtons = availableButtons; AvailableButtons = availableButtons;
}
/// <summary> _allSystemInfos.Add(this);
/// Initialize a new instance of <see cref="SystemInfo"/>
/// </summary>
/// <param name="displayName">A <see cref="string"/> that specify how the system name is displayed</param>
/// <param name="system">A <see cref="CoreSystem"/> that specify what core is used</param>
/// <param name="maxControllers">Maximum controller allowed by this system</param>
private SystemInfo(string displayName, CoreSystem system, int maxControllers)
: this(displayName, system, maxControllers, 0)
{
}
/// <summary>
/// Initialize a new instance of <see cref="SystemInfo"/>
/// </summary>
/// <param name="displayName">A <see cref="string"/> that specify how the system name is displayed</param>
private SystemInfo(string displayName)
: this(displayName, CoreSystem.Null, 0, 0)
{
} }
#endregion #endregion
@ -109,132 +46,132 @@ namespace BizHawk.Client.Common
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Apple II /// Gets the <see cref="SystemInfo"/> instance for Apple II
/// </summary /// </summary
public static SystemInfo AppleII => allSystemInfos[25]; public static SystemInfo AppleII { get; } = new SystemInfo("Apple II", CoreSystem.AppleII, 1);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Atari 2600 /// Gets the <see cref="SystemInfo"/> instance for Atari 2600
/// </summary /// </summary
public static SystemInfo Atari2600 => allSystemInfos[14]; public static SystemInfo Atari2600 { get; } = new SystemInfo("Atari 2600", CoreSystem.Atari2600, 1);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Atari 7800 /// Gets the <see cref="SystemInfo"/> instance for Atari 7800
/// </summary> /// </summary>
public static SystemInfo Atari7800 => allSystemInfos[15]; public static SystemInfo Atari7800 { get; } = new SystemInfo("Atari 7800", CoreSystem.Atari7800, 1);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Commodore 64 /// Gets the <see cref="SystemInfo"/> instance for Commodore 64
/// </summary> /// </summary>
public static SystemInfo C64 => allSystemInfos[16]; public static SystemInfo C64 { get; } = new SystemInfo("Commodore 64", CoreSystem.Commodore64, 1);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Coleco Vision /// Gets the <see cref="SystemInfo"/> instance for Coleco Vision
/// </summary> /// </summary>
public static SystemInfo Coleco => allSystemInfos[17]; public static SystemInfo Coleco { get; } = new SystemInfo("ColecoVision", CoreSystem.ColecoVision, 1);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Dual Gameboy /// Gets the <see cref="SystemInfo"/> instance for Dual Gameboy
/// </summary> /// </summary>
public static SystemInfo DualGB => allSystemInfos[21]; public static SystemInfo DualGB { get; } = new SystemInfo("Game Boy Link", CoreSystem.DualGameBoy, 2, StandardButtons);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Gameboy /// Gets the <see cref="SystemInfo"/> instance for Gameboy
/// </summary> /// </summary>
public static SystemInfo GB => allSystemInfos[12]; public static SystemInfo GB { get; } = new SystemInfo("GB", CoreSystem.GameBoy, 1, StandardButtons);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Gameboy Advance /// Gets the <see cref="SystemInfo"/> instance for Gameboy Advance
/// </summary> /// </summary>
public static SystemInfo GBA => allSystemInfos[18]; public static SystemInfo GBA { get; } = new SystemInfo("Gameboy Advance", CoreSystem.GameBoyAdvance, 1, StandardButtons | JoypadButton.L | JoypadButton.R);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Gameboy Color /// Gets the <see cref="SystemInfo"/> instance for Gameboy Color
/// </summary> /// </summary>
public static SystemInfo GBC => allSystemInfos[13]; public static SystemInfo GBC { get; } = new SystemInfo("Gameboy Color", CoreSystem.GameBoy, 1, StandardButtons);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Genesis /// Gets the <see cref="SystemInfo"/> instance for Genesis
/// </summary> /// </summary>
public static SystemInfo Genesis => allSystemInfos[9]; public static SystemInfo Genesis { get; } = new SystemInfo("Genesis", CoreSystem.Genesis, 2, UpDownLeftRight | JoypadButton.A | JoypadButton.B | JoypadButton.C | JoypadButton.X | JoypadButton.Y | JoypadButton.Z);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Game Gear /// Gets the <see cref="SystemInfo"/> instance for Game Gear
/// </summary> /// </summary>
public static SystemInfo GG => allSystemInfos[5]; public static SystemInfo GG { get; } = new SystemInfo("Game Gear", CoreSystem.MasterSystem, 1, UpDownLeftRight | JoypadButton.B1 | JoypadButton.B2);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Intellivision /// Gets the <see cref="SystemInfo"/> instance for Intellivision
/// </summary> /// </summary>
public static SystemInfo Intellivision => allSystemInfos[2]; public static SystemInfo Intellivision { get; } = new SystemInfo("Intellivision", CoreSystem.Intellivision, 2);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Lynx /// Gets the <see cref="SystemInfo"/> instance for Lynx
/// </summary> /// </summary>
public static SystemInfo Lynx => allSystemInfos[23]; public static SystemInfo Lynx { get; } = new SystemInfo("Lynx", CoreSystem.Lynx, 1);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for NES /// Gets the <see cref="SystemInfo"/> instance for NES
/// </summary> /// </summary>
public static SystemInfo Nes => allSystemInfos[1]; public static SystemInfo Nes { get; } = new SystemInfo("NES", CoreSystem.NES, 2, StandardButtons);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Nintendo 64 /// Gets the <see cref="SystemInfo"/> instance for Nintendo 64
/// </summary> /// </summary>
public static SystemInfo N64 => allSystemInfos[19]; public static SystemInfo N64 { get; } = new SystemInfo("Nintendo 64", CoreSystem.Nintendo64, 4, StandardButtons ^ JoypadButton.Select | JoypadButton.Z | JoypadButton.CUp | JoypadButton.CDown | JoypadButton.CLeft | JoypadButton.CRight | JoypadButton.AnalogStick | JoypadButton.L | JoypadButton.R);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Null (i.e. nothing is emulated) emulator /// Gets the <see cref="SystemInfo"/> instance for Null (i.e. nothing is emulated) emulator
/// </summary> /// </summary>
public static SystemInfo Null => allSystemInfos[0]; public static SystemInfo Null { get; } = new SystemInfo(string.Empty, CoreSystem.Null, 0);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for PCEngine (TurboGrafx-16) /// Gets the <see cref="SystemInfo"/> instance for PCEngine (TurboGrafx-16)
/// </summary> /// </summary>
public static SystemInfo PCE => allSystemInfos[6]; public static SystemInfo PCE { get; } = new SystemInfo("TurboGrafx-16", CoreSystem.PCEngine, 1);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for PCEngine (TurboGrafx-16) + CD /// Gets the <see cref="SystemInfo"/> instance for PCEngine (TurboGrafx-16) + CD
/// </summary> /// </summary>
public static SystemInfo PCECD => allSystemInfos[7]; public static SystemInfo PCECD { get; } = new SystemInfo("TurboGrafx - 16(CD)", CoreSystem.PCEngine, 1);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for PlayStation /// Gets the <see cref="SystemInfo"/> instance for PlayStation
/// </summary> /// </summary>
public static SystemInfo PSX => allSystemInfos[24]; public static SystemInfo PSX { get; } = new SystemInfo("PlayStation", CoreSystem.Playstation, 2);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Sega Saturn /// Gets the <see cref="SystemInfo"/> instance for Sega Saturn
/// </summary> /// </summary>
public static SystemInfo Saturn => allSystemInfos[20]; public static SystemInfo Saturn { get; } = new SystemInfo("Saturn", CoreSystem.Saturn, 2, UpDownLeftRight | JoypadButton.A | JoypadButton.B | JoypadButton.C | JoypadButton.X | JoypadButton.Y | JoypadButton.Z);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for SG-1000 (Sega Game 1000) /// Gets the <see cref="SystemInfo"/> instance for SG-1000 (Sega Game 1000)
/// </summary> /// </summary>
public static SystemInfo SG => allSystemInfos[4]; public static SystemInfo SG { get; } = new SystemInfo("SG-1000", CoreSystem.MasterSystem, 1);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for PCEngine (Supergraph FX) /// Gets the <see cref="SystemInfo"/> instance for PCEngine (Supergraph FX)
/// </summary> /// </summary>
public static SystemInfo SGX => allSystemInfos[8]; public static SystemInfo SGX { get; } = new SystemInfo("SuperGrafx", CoreSystem.PCEngine, 1);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for Sega Master System /// Gets the <see cref="SystemInfo"/> instance for Sega Master System
/// </summary> /// </summary>
public static SystemInfo SMS => allSystemInfos[3]; public static SystemInfo SMS { get; } = new SystemInfo("Sega Master System", CoreSystem.MasterSystem, 2, UpDownLeftRight | JoypadButton.B1 | JoypadButton.B2);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for SNES /// Gets the <see cref="SystemInfo"/> instance for SNES
/// </summary> /// </summary>
public static SystemInfo SNES => allSystemInfos[11]; public static SystemInfo SNES { get; } = new SystemInfo("SNES", CoreSystem.SNES, 8, StandardButtons | JoypadButton.X | JoypadButton.Y | JoypadButton.L | JoypadButton.R);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for TI-83 /// Gets the <see cref="SystemInfo"/> instance for TI-83
/// </summary> /// </summary>
public static SystemInfo TI83 => allSystemInfos[10]; public static SystemInfo TI83 { get; } = new SystemInfo("TI - 83", CoreSystem.TI83, 1);
/// <summary> /// <summary>
/// Gets the <see cref="SystemInfo"/> instance for TI-83 /// Gets the <see cref="SystemInfo"/> instance for TI-83
/// </summary> /// </summary>
public static SystemInfo WonderSwan => allSystemInfos[22]; public static SystemInfo WonderSwan { get; } = new SystemInfo("WonderSwan", CoreSystem.WonderSwan, 1);
#endregion Get SystemInfo #endregion Get SystemInfo
@ -245,7 +182,7 @@ namespace BizHawk.Client.Common
/// <returns>Mathing <see cref="SystemInfo"/></returns> /// <returns>Mathing <see cref="SystemInfo"/></returns>
public static SystemInfo FindByCoreSystem(CoreSystem system) public static SystemInfo FindByCoreSystem(CoreSystem system)
{ {
return allSystemInfos.Find(s => s._System == system); return _allSystemInfos.Find(s => s.System == system);
} }
/// <summary> /// <summary>
@ -279,10 +216,9 @@ namespace BizHawk.Client.Common
/// <returns></returns> /// <returns></returns>
public override string ToString() public override string ToString()
{ {
return _DisplayName; return DisplayName;
} }
/// <summary> /// <summary>
/// Determine if two <see cref="SystemInfo"/> are equals. /// Determine if two <see cref="SystemInfo"/> are equals.
/// As it is all static instance, it just compare their reference /// As it is all static instance, it just compare their reference
@ -314,22 +250,22 @@ namespace BizHawk.Client.Common
/// <summary> /// <summary>
/// Gets <see cref="JoypadButton"/> available for this system /// Gets <see cref="JoypadButton"/> available for this system
/// </summary> /// </summary>
public JoypadButton AvailableButtons => _AvailableButtons; public JoypadButton AvailableButtons { get; }
/// <summary> /// <summary>
/// Gets the sytem name as <see cref="string"/> /// Gets the sytem name as <see cref="string"/>
/// </summary> /// </summary>
public string DisplayName => _DisplayName; public string DisplayName { get; }
/// <summary> /// <summary>
/// Gets the maximum amount of controller allowed for this system /// Gets the maximum amount of controller allowed for this system
/// </summary> /// </summary>
public int MaxControllers => _MaxControllers; public int MaxControllers { get; }
/// <summary> /// <summary>
/// Gets core used for this system as <see cref="CoreSystem"/> enum /// Gets core used for this system as <see cref="CoreSystem"/> enum
/// </summary> /// </summary>
public CoreSystem System => _System; public CoreSystem System { get; }
#endregion #endregion
} }