Add setters and getters for Machine

This commit is contained in:
Matt Nadareski
2024-03-09 23:43:43 -05:00
parent f37e3a07da
commit c2e30138db
55 changed files with 534 additions and 890 deletions

View File

@@ -1,10 +1,7 @@
using System;
using System.Linq;
using System.Xml.Serialization;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using SabreTools.Core;
using SabreTools.Core.Tools;
using SabreTools.Filter;
namespace SabreTools.DatItems
@@ -17,340 +14,6 @@ namespace SabreTools.DatItems
{
#region Fields
#region Common
/// <summary>
/// Name of the machine
/// </summary>
[JsonProperty("name", DefaultValueHandling = DefaultValueHandling.Include)]
[XmlElement("name")]
public string? Name
{
get => _machine.ReadString(Models.Metadata.Machine.NameKey);
set => _machine[Models.Metadata.Machine.NameKey] = value;
}
/// <summary>
/// Additional notes
/// </summary>
/// <remarks>Known as "Extra" in AttractMode</remarks>
[JsonProperty("comment", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("comment")]
public string? Comment
{
get => _machine.ReadString(Models.Metadata.Machine.CommentKey);
set => _machine[Models.Metadata.Machine.CommentKey] = value;
}
/// <summary>
/// Extended description
/// </summary>
[JsonProperty("description", DefaultValueHandling = DefaultValueHandling.Include)]
[XmlElement("description")]
public string? Description
{
get => _machine.ReadString(Models.Metadata.Machine.DescriptionKey);
set => _machine[Models.Metadata.Machine.DescriptionKey] = value;
}
/// <summary>
/// Year(s) of release/manufacture
/// </summary>
[JsonProperty("year", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("year")]
public string? Year
{
get => _machine.ReadString(Models.Metadata.Machine.YearKey);
set => _machine[Models.Metadata.Machine.YearKey] = value;
}
/// <summary>
/// Manufacturer, if available
/// </summary>
[JsonProperty("manufacturer", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("manufacturer")]
public string? Manufacturer
{
get => _machine.ReadString(Models.Metadata.Machine.ManufacturerKey);
set => _machine[Models.Metadata.Machine.ManufacturerKey] = value;
}
/// <summary>
/// Publisher, if available
/// </summary>
[JsonProperty("publisher", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("publisher")]
public string? Publisher
{
get => _machine.ReadString(Models.Metadata.Machine.PublisherKey);
set => _machine[Models.Metadata.Machine.PublisherKey] = value;
}
/// <summary>
/// Category, if available
/// </summary>
[JsonProperty("category", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("category")]
public string? Category
{
get => _machine.ReadString(Models.Metadata.Machine.CategoryKey);
set => _machine[Models.Metadata.Machine.CategoryKey] = value;
}
/// <summary>
/// fomof parent
/// </summary>
[JsonProperty("romof", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("romof")]
public string? RomOf
{
get => _machine.ReadString(Models.Metadata.Machine.RomOfKey);
set => _machine[Models.Metadata.Machine.RomOfKey] = value;
}
/// <summary>
/// cloneof parent
/// </summary>
[JsonProperty("cloneof", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("cloneof")]
public string? CloneOf
{
get => _machine.ReadString(Models.Metadata.Machine.CloneOfKey);
set => _machine[Models.Metadata.Machine.CloneOfKey] = value;
}
/// <summary>
/// sampleof parent
/// </summary>
[JsonProperty("sampleof", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("sampleof")]
public string? SampleOf
{
get => _machine.ReadString(Models.Metadata.Machine.SampleOfKey);
set => _machine[Models.Metadata.Machine.SampleOfKey] = value;
}
/// <summary>
/// Type of the machine
/// </summary>
[JsonProperty("type", DefaultValueHandling = DefaultValueHandling.Ignore)]
[JsonConverter(typeof(StringEnumConverter))]
[XmlElement("type")]
public MachineType MachineType
{
get
{
bool? isBios = _machine.ReadBool(Models.Metadata.Machine.IsBiosKey);
bool? isDevice = _machine.ReadBool(Models.Metadata.Machine.IsDeviceKey);
bool? isMechanical = _machine.ReadBool(Models.Metadata.Machine.IsMechanicalKey);
MachineType machineType = MachineType.None;
if (isBios == true)
machineType |= MachineType.Bios;
if (isDevice == true)
machineType |= MachineType.Device;
if (isMechanical == true)
machineType |= MachineType.Mechanical;
return machineType;
}
set
{
#if NETFRAMEWORK
if ((value & MachineType.Bios) != 0)
_machine[Models.Metadata.Machine.IsBiosKey] = "yes";
if ((value & MachineType.Device) != 0)
_machine[Models.Metadata.Machine.IsDeviceKey] = "yes";
if ((value & MachineType.Mechanical) != 0)
_machine[Models.Metadata.Machine.IsMechanicalKey] = "yes";
#else
if (value.HasFlag(MachineType.Bios))
_machine[Models.Metadata.Machine.IsBiosKey] = "yes";
if (value.HasFlag(MachineType.Device))
_machine[Models.Metadata.Machine.IsDeviceKey] = "yes";
if (value.HasFlag(MachineType.Mechanical))
_machine[Models.Metadata.Machine.IsMechanicalKey] = "yes";
#endif
}
}
[JsonIgnore]
public bool MachineTypeSpecified { get { return MachineType != 0x0 && MachineType != MachineType.None; } }
#endregion
#region AttractMode
/// <summary>
/// Player count
/// </summary>
/// <remarks>Also in Logiqx EmuArc</remarks>
[JsonProperty("players", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("players")]
public string? Players
{
get => _machine.ReadString(Models.Metadata.Machine.PlayersKey);
set => _machine[Models.Metadata.Machine.PlayersKey] = value;
}
/// <summary>
/// Screen rotation
/// </summary>
[JsonProperty("rotation", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("rotation")]
public string? Rotation
{
get => _machine.ReadString(Models.Metadata.Machine.RotationKey);
set => _machine[Models.Metadata.Machine.RotationKey] = value;
}
/// <summary>
/// Control method
/// </summary>
[JsonProperty("control", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("control")]
public string? Control
{
get => _machine.ReadString(Models.Metadata.Machine.ControlKey);
set => _machine[Models.Metadata.Machine.ControlKey] = value;
}
/// <summary>
/// Support status
/// </summary>
[JsonProperty("status", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("status")]
public string? Status
{
get => _machine.ReadString(Models.Metadata.Machine.StatusKey);
set => _machine[Models.Metadata.Machine.StatusKey] = value;
}
/// <summary>
/// Display count
/// </summary>
[JsonProperty("displaycount", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("displaycount")]
public string? DisplayCount
{
get => _machine.ReadString(Models.Metadata.Machine.DisplayCountKey);
set => _machine[Models.Metadata.Machine.DisplayCountKey] = value;
}
/// <summary>
/// Display type
/// </summary>
[JsonProperty("displaytype", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("displaytype")]
public string? DisplayType
{
get => _machine.ReadString(Models.Metadata.Machine.DisplayTypeKey);
set => _machine[Models.Metadata.Machine.DisplayTypeKey] = value;
}
/// <summary>
/// Number of input buttons
/// </summary>
[JsonProperty("buttons", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("buttons")]
public string? Buttons
{
get => _machine.ReadString(Models.Metadata.Machine.ButtonsKey);
set => _machine[Models.Metadata.Machine.ButtonsKey] = value;
}
#endregion
#region ListXML
/// <summary>
/// History.dat entry for the machine
/// </summary>
[JsonProperty("history", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("history")]
public string? History
{
get => _machine.ReadString(Models.Metadata.Machine.HistoryKey);
set => _machine[Models.Metadata.Machine.HistoryKey] = value;
}
/// <summary>
/// Emulator source file related to the machine
/// </summary>
/// <remarks>Also in Logiqx</remarks>
[JsonProperty("sourcefile", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("sourcefile")]
public string? SourceFile
{
get => _machine.ReadString(Models.Metadata.Machine.SourceFileKey);
set => _machine[Models.Metadata.Machine.SourceFileKey] = value;
}
/// <summary>
/// Machine runnable status
/// </summary>
/// <remarks>Also in Logiqx</remarks>
[JsonProperty("runnable", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("runnable")]
public Runnable Runnable
{
get => _machine.ReadString(Models.Metadata.Machine.RunnableKey).AsEnumValue<Runnable>();
set => _machine[Models.Metadata.Machine.RunnableKey] = value.AsStringValue<Runnable>();
}
[JsonIgnore]
public bool RunnableSpecified { get { return Runnable != Runnable.NULL; } }
#endregion
#region Logiqx
/// <summary>
/// Machine board name
/// </summary>
[JsonProperty("board", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("board")]
public string? Board
{
get => _machine.ReadString(Models.Metadata.Machine.BoardKey);
set => _machine[Models.Metadata.Machine.BoardKey] = value;
}
/// <summary>
/// Rebuild location if different than machine name
/// </summary>
[JsonProperty("rebuildto", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("rebuildto")]
public string? RebuildTo
{
get => _machine.ReadString(Models.Metadata.Machine.RebuildToKey);
set => _machine[Models.Metadata.Machine.RebuildToKey] = value;
}
/// <summary>
/// No-Intro ID for the game
/// </summary>
[JsonProperty("nointroid", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("nointroid")]
public string? NoIntroId
{
get => _machine.ReadString(Models.Metadata.Machine.IdKey);
set => _machine[Models.Metadata.Machine.IdKey] = value;
}
/// <summary>
/// No-Intro ID for the game
/// </summary>
[JsonProperty("nointrocloneofid", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("nointrocloneofid")]
public string? NoIntroCloneOfId
{
get => _machine.ReadString(Models.Metadata.Machine.CloneOfIdKey);
set => _machine[Models.Metadata.Machine.CloneOfIdKey] = value;
}
#endregion
// TODO: Should this be a separate object for TruRip?
#region Logiqx EmuArc
@@ -422,68 +85,51 @@ namespace SabreTools.DatItems
#endregion
#region OpenMSX
/// <summary>
/// Generation MSX ID
/// </summary>
[JsonProperty("genmsxid", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("genmsxid")]
public string? GenMSXID
{
get => _machine.ReadString(Models.Metadata.Machine.GenMSXIDKey);
set => _machine[Models.Metadata.Machine.GenMSXIDKey] = value;
}
/// <summary>
/// MSX System
/// </summary>
[JsonProperty("system", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("system")]
public string? System
{
get => _machine.ReadString(Models.Metadata.Machine.SystemKey);
set => _machine[Models.Metadata.Machine.SystemKey] = value;
}
/// <summary>
/// Machine country of origin
/// </summary>
[JsonProperty("country", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("country")]
public string? Country
{
get => _machine.ReadString(Models.Metadata.Machine.CountryKey);
set => _machine[Models.Metadata.Machine.CountryKey] = value;
}
#endregion
#region SoftwareList
/// <summary>
/// Support status
/// </summary>
[JsonProperty("supported", DefaultValueHandling = DefaultValueHandling.Ignore)]
[XmlElement("supported")]
public Supported Supported
{
get => _machine.ReadString(Models.Metadata.Machine.SupportedKey).AsEnumValue<Supported>();
set => _machine[Models.Metadata.Machine.SupportedKey] = value.AsStringValue<Supported>(useSecond: true);
}
[JsonIgnore]
public bool SupportedSpecified { get { return Supported != Supported.NULL; } }
#endregion
/// <summary>
/// Internal Machine model
/// </summary>
[JsonIgnore]
private Models.Metadata.Machine _machine = [];
#endregion // Fields
#endregion
#region Accessors
/// <summary>
/// Get the value from a field based on the type provided
/// </summary>
/// <typeparam name="T">Type of the value to get from the internal model</typeparam>
/// <param name="fieldName">Field to retrieve</param>
/// <returns>Value from the field, if possible</returns>
public T? GetFieldValue<T>(string? fieldName)
{
// Invalid field cannot be processed
if (string.IsNullOrEmpty(fieldName))
return default;
// Get the value based on the type
return _machine.Read<T>(fieldName!);
}
/// <summary>
/// Set the value from a field based on the type provided
/// </summary>
/// <typeparam name="T">Type of the value to set in the internal model</typeparam>
/// <param name="fieldName">Field to set</param>
/// <param name="value">Value to set</param>
/// <returns>True if the value was set, false otherwise</returns>
public bool SetFieldValue<T>(string? fieldName, T? value)
{
// Invalid field cannot be processed
if (string.IsNullOrEmpty(fieldName))
return false;
// Set the value based on the type
_machine[fieldName!] = value;
return true;
}
#endregion
#region Constructors
@@ -521,8 +167,8 @@ namespace SabreTools.DatItems
/// <param name="description">Description of the machine</param>
public Machine(string name, string description)
{
Name = name;
Description = description;
SetFieldValue<string?>(Models.Metadata.Machine.NameKey, name);
SetFieldValue<string?>(Models.Metadata.Machine.DescriptionKey, description);
}
#endregion