using System.Collections.Generic; using System.IO; using System.Linq; using SabreTools.Library.Filtering; using Newtonsoft.Json; using SabreTools.Library.Tools; namespace SabreTools.Library.DatItems { /// /// Represents one ListXML confsetting or dipvalue /// [JsonObject("setting")] public class Setting : DatItem { #region Fields /// /// Setting name /// [JsonProperty("name")] public string Name { get; set; } /// /// Setting value /// [JsonProperty("value", DefaultValueHandling = DefaultValueHandling.Ignore)] public string SettingValue { get; set; } /// /// Determines if the setting is default or not /// [JsonProperty("default", DefaultValueHandling = DefaultValueHandling.Ignore)] public bool? Default { get; set; } /// /// List of conditions on the setting /// [JsonProperty("conditions", DefaultValueHandling = DefaultValueHandling.Ignore)] public List Conditions { get; set; } #endregion #region Accessors /// /// Gets the name to use for a DatItem /// /// Name if available, null otherwise public override string GetName() { return Name; } /// /// Set fields with given values /// /// Mappings dictionary public override void SetFields(Dictionary mappings) { // Set base fields base.SetFields(mappings); // Handle Setting-specific fields if (mappings.Keys.Contains(Field.DatItem_Setting_Name)) Name = mappings[Field.DatItem_Setting_Name]; if (mappings.Keys.Contains(Field.DatItem_Setting_Value)) SettingValue = mappings[Field.DatItem_Setting_Value]; if (mappings.Keys.Contains(Field.DatItem_Setting_Default)) Default = mappings[Field.DatItem_Setting_Default].AsYesNo(); // Field.DatItem_Conditions does not apply here if (Conditions != null) { foreach (Condition condition in Conditions) { condition.SetFields(mappings); } } } #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() { Name = this.Name, ItemType = this.ItemType, DupeType = this.DupeType, AltName = this.AltName, AltTitle = this.AltTitle, Original = this.Original, OpenMSXSubType = this.OpenMSXSubType, OpenMSXType = this.OpenMSXType, Remark = this.Remark, Boot = this.Boot, Part = this.Part, Features = this.Features, AreaName = this.AreaName, AreaSize = this.AreaSize, AreaWidth = this.AreaWidth, AreaEndianness = this.AreaEndianness, Value = this.Value, LoadFlag = this.LoadFlag, Machine = this.Machine.Clone() as Machine, Source = this.Source.Clone() as Source, Remove = this.Remove, SettingValue = this.SettingValue, 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 && SettingValue == newOther.SettingValue && Default == newOther.Default); if (!match) return match; // If the conditions match if (Conditions != null) { 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 = Sanitizer.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; } } } /// /// Check to see if a DatItem passes the filter /// /// Filter to check against /// True if the item passed the filter, false otherwise public override bool PassesFilter(Filter filter) { // Check common fields first if (!base.PassesFilter(filter)) return false; // Filter on item name if (filter.DatItem_Setting_Name.MatchesPositiveSet(Name) == false) return false; if (filter.DatItem_Setting_Name.MatchesNegativeSet(Name) == true) return false; // Filter on value if (filter.DatItem_Setting_Value.MatchesPositiveSet(SettingValue) == false) return false; if (filter.DatItem_Setting_Value.MatchesNegativeSet(SettingValue) == true) return false; // Filter on default if (filter.DatItem_Setting_Default.MatchesNeutral(null, Default) == false) return false; // Filter on conditions if (filter.DatItem_Conditions.MatchesNeutral(null, Conditions != null ? (bool?)(Conditions.Count > 0) : null) == false) return false; // Filter on individual conditions if (Conditions != null) { foreach (Condition condition in Conditions) { if (!condition.PassesFilter(filter)) return false; } } return true; } /// /// Remove fields from the DatItem /// /// List of Fields to remove public override void RemoveFields(List fields) { // Remove common fields first base.RemoveFields(fields); // Remove the fields if (fields.Contains(Field.DatItem_Setting_Name)) Name = null; if (fields.Contains(Field.DatItem_Setting_Value)) SettingValue = null; if (fields.Contains(Field.DatItem_Setting_Default)) Default = null; if (fields.Contains(Field.DatItem_Conditions)) Conditions = null; if (Conditions != null) { foreach (Condition condition in Conditions) { condition.RemoveFields(fields); } } } /// /// 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 /// /// Replace fields from another item /// /// DatItem to pull new information from /// List of Fields representing what should be updated public override void ReplaceFields(DatItem item, List fields) { // Replace common fields first base.ReplaceFields(item, fields); // 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 (fields.Contains(Field.DatItem_Setting_Name)) Name = newItem.Name; if (fields.Contains(Field.DatItem_Setting_Value)) SettingValue = newItem.SettingValue; if (fields.Contains(Field.DatItem_Setting_Default)) Default = newItem.Default; // Field replacement doesn't make sense for DatItem_Condition* } #endregion } }