using System.Collections.Generic; using System.IO; using System.Linq; using SabreTools.Library.Filtering; using SabreTools.Library.Tools; using Newtonsoft.Json; using Newtonsoft.Json.Converters; namespace SabreTools.Library.DatItems { /// /// Represents which Chip(s) is associated with a set /// [JsonObject("chip")] public class Chip : DatItem { #region Fields /// /// Name of the item /// [JsonProperty("name")] public string Name { get; set; } /// /// Internal tag /// [JsonProperty("tag", DefaultValueHandling = DefaultValueHandling.Ignore)] public string Tag { get; set; } /// /// Type of the chip /// [JsonProperty("chiptype", DefaultValueHandling = DefaultValueHandling.Ignore)] [JsonConverter(typeof(StringEnumConverter))] public ChipType ChipType { get; set; } /// /// Clock speed /// [JsonProperty("clock", DefaultValueHandling = DefaultValueHandling.Ignore)] public string Clock { 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 Chip-specific fields if (mappings.Keys.Contains(Field.DatItem_Name)) Name = mappings[Field.DatItem_Name]; if (mappings.Keys.Contains(Field.DatItem_Tag)) Tag = mappings[Field.DatItem_Tag]; if (mappings.Keys.Contains(Field.DatItem_ChipType)) ChipType = mappings[Field.DatItem_ChipType].AsChipType(); if (mappings.Keys.Contains(Field.DatItem_Clock)) Clock = mappings[Field.DatItem_Clock]; } #endregion #region Constructors /// /// Create a default, empty Chip object /// public Chip() { Name = string.Empty; ItemType = ItemType.Chip; } #endregion #region Cloning Methods public override object Clone() { return new Chip() { Name = this.Name, ItemType = this.ItemType, DupeType = this.DupeType, AltName = this.AltName, AltTitle = this.AltTitle, Machine = this.Machine.Clone() as Machine, Source = this.Source.Clone() as Source, Remove = this.Remove, Tag = this.Tag, ChipType = this.ChipType, Clock = this.Clock, }; } #endregion #region Comparision Methods public override bool Equals(DatItem other) { // If we don't have a chip, return false if (ItemType != other.ItemType) return false; // Otherwise, treat it as a chip Chip newOther = other as Chip; // If the chip information matches return (Name == newOther.Name && Tag == newOther.Tag && ChipType == newOther.ChipType && Clock == newOther.Clock); } #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_Name.MatchesPositiveSet(Name) == false) return false; if (filter.DatItem_Name.MatchesNegativeSet(Name) == true) return false; // DatItem_Tag if (filter.DatItem_Tag.MatchesPositiveSet(Tag) == false) return false; if (filter.DatItem_Tag.MatchesNegativeSet(Tag) == true) return false; // DatItem_ChipType if (filter.DatItem_ChipType.MatchesPositive(ChipType.NULL, ChipType) == false) return false; if (filter.DatItem_ChipType.MatchesNegative(ChipType.NULL, ChipType) == true) return false; // DatItem_Clock if (filter.DatItem_Clock.MatchesPositiveSet(Clock) == false) return false; if (filter.DatItem_Clock.MatchesNegativeSet(Clock) == true) 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_Name)) Name = null; if (fields.Contains(Field.DatItem_Tag)) Tag = null; if (fields.Contains(Field.DatItem_ChipType)) ChipType = ChipType.NULL; if (fields.Contains(Field.DatItem_Clock)) Clock = null; } /// /// 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 Chip to replace from, ignore specific fields if (item.ItemType != ItemType.Chip) return; // Cast for easier access Chip newItem = item as Chip; // Replace the fields if (fields.Contains(Field.DatItem_Name)) Name = newItem.Name; if (fields.Contains(Field.DatItem_Tag)) Tag = newItem.Tag; if (fields.Contains(Field.DatItem_ChipType)) ChipType = newItem.ChipType; if (fields.Contains(Field.DatItem_Clock)) Clock = newItem.Clock; } #endregion } }