using System.Collections.Generic; using System.IO; using System.Linq; using System.Xml.Serialization; using SabreTools.Core; using SabreTools.Core.Tools; using SabreTools.Filtering; using Newtonsoft.Json; namespace SabreTools.DatItems { /// /// Represents one ListXML confsetting or dipvalue /// [JsonObject("setting"), XmlRoot("setting")] public class Setting : DatItem { #region Fields /// /// Setting name /// [JsonProperty("name")] [XmlElement("name")] public string Name { get; set; } /// /// Setting value /// [JsonProperty("value", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("value")] public string Value { get; set; } /// /// Determines if the setting is default or not /// [JsonProperty("default", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("default")] public bool? Default { get; set; } [JsonIgnore] public bool DefaultSpecified { get { return Default != null; } } /// /// List of conditions on the setting /// [JsonProperty("conditions", DefaultValueHandling = DefaultValueHandling.Ignore)] [XmlElement("conditions")] public List Conditions { get; set; } [JsonIgnore] public bool ConditionsSpecified { get { return Conditions != null && Conditions.Count > 0; } } #endregion #region Accessors /// /// Gets the name to use for a DatItem /// /// Name if available, null otherwise public override string GetName() { return Name; } /// public override void SetFields( Dictionary datItemMappings, Dictionary machineMappings) { // Set base fields base.SetFields(datItemMappings, machineMappings); // Handle Setting-specific fields if (datItemMappings.Keys.Contains(DatItemField.Setting_Name)) Name = datItemMappings[DatItemField.Setting_Name]; if (datItemMappings.Keys.Contains(DatItemField.Setting_Value)) Value = datItemMappings[DatItemField.Setting_Value]; if (datItemMappings.Keys.Contains(DatItemField.Setting_Default)) Default = datItemMappings[DatItemField.Setting_Default].AsYesNo(); if (ConditionsSpecified) { foreach (Condition condition in Conditions) { condition.SetFields(datItemMappings, machineMappings, true); } } } #endregion #region Constructors /// /// Create a default, empty Setting object /// public Setting() { Name = string.Empty; ItemType = ItemType.Setting; } #endregion #region Cloning Methods public override object Clone() { return new Setting() { ItemType = this.ItemType, DupeType = this.DupeType, Machine = this.Machine.Clone() as Machine, Source = this.Source.Clone() as Source, Remove = this.Remove, Name = this.Name, Value = this.Value, Default = this.Default, Conditions = this.Conditions, }; } #endregion #region Comparision Methods public override bool Equals(DatItem other) { // If we don't have a Setting, return false if (ItemType != other.ItemType) return false; // Otherwise, treat it as a Setting Setting newOther = other as Setting; // If the Setting information matches bool match = (Name == newOther.Name && Value == newOther.Value && Default == newOther.Default); if (!match) return match; // If the conditions match if (ConditionsSpecified) { foreach (Condition condition in Conditions) { match &= newOther.Conditions.Contains(condition); } } return match; } #endregion #region Filtering /// /// Clean a DatItem according to the cleaner /// /// Cleaner to implement public override void Clean(Cleaner cleaner) { // Clean common items first base.Clean(cleaner); // If we're stripping unicode characters, strip item name if (cleaner?.RemoveUnicode == true) Name = RemoveUnicodeCharacters(Name); // If we are in NTFS trim mode, trim the game name if (cleaner?.Trim == true) { // Windows max name length is 260 int usableLength = 260 - Machine.Name.Length - (cleaner.Root?.Length ?? 0); if (Name.Length > usableLength) { string ext = Path.GetExtension(Name); Name = Name.Substring(0, usableLength - ext.Length); Name += ext; } } } /// public override bool PassesFilter(Cleaner cleaner, bool sub = false) { // Check common fields first if (!base.PassesFilter(cleaner, sub)) return false; // Filter on item name if (!Filter.PassStringFilter(cleaner.DatItemFilter.Setting_Name, Name)) return false; // Filter on value if (!Filter.PassStringFilter(cleaner.DatItemFilter.Setting_Value, Value)) return false; // Filter on default if (!Filter.PassBoolFilter(cleaner.DatItemFilter.Setting_Default, Default)) return false; // Filter on individual conditions if (ConditionsSpecified) { foreach (Condition condition in Conditions) { if (!condition.PassesFilter(cleaner, true)) return false; } } return true; } /// public override void RemoveFields( List datItemFields, List machineFields) { // Remove common fields first base.RemoveFields(datItemFields, machineFields); // Remove the fields if (datItemFields.Contains(DatItemField.Setting_Name)) Name = null; if (datItemFields.Contains(DatItemField.Setting_Value)) Value = null; if (datItemFields.Contains(DatItemField.Setting_Default)) Default = null; if (ConditionsSpecified) { foreach (Condition condition in Conditions) { condition.RemoveFields(datItemFields, machineFields, true); } } } /// /// Set internal names to match One Rom Per Game (ORPG) logic /// public override void SetOneRomPerGame() { string[] splitname = Name.Split('.'); Machine.Name += $"/{string.Join(".", splitname.Take(splitname.Length > 1 ? splitname.Length - 1 : 1))}"; Name = Path.GetFileName(Name); } #endregion #region Sorting and Merging /// public override void ReplaceFields( DatItem item, List datItemFields, List machineFields) { // Replace common fields first base.ReplaceFields(item, datItemFields, machineFields); // If we don't have a Setting to replace from, ignore specific fields if (item.ItemType != ItemType.Setting) return; // Cast for easier access Setting newItem = item as Setting; // Replace the fields if (datItemFields.Contains(DatItemField.Setting_Name)) Name = newItem.Name; if (datItemFields.Contains(DatItemField.Setting_Value)) Value = newItem.Value; if (datItemFields.Contains(DatItemField.Setting_Default)) Default = newItem.Default; // DatItem_Condition_* doesn't make sense here // since not every condition under the other item // can replace every condition under this item } #endregion } }