SabreTools/SabreTools.Library/DatItems/Device.cs

using System.Collections.Generic;
using System.Linq;

using SabreTools.Library.Filtering;
using Newtonsoft.Json;

namespace SabreTools.Library.DatItems
{
    /// <summary>
    /// Represents a single device on the machine
    /// </summary>
    [JsonObject("device")]
    public class Device : DatItem
    {
        #region Fields

        /// <summary>
        /// Device type
        /// </summary>
        [JsonProperty("type", DefaultValueHandling = DefaultValueHandling.Ignore)]
        public string DeviceType { get; set; }

        /// <summary>
        /// Device tag
        /// </summary>
        [JsonProperty("tag", DefaultValueHandling = DefaultValueHandling.Ignore)]
        public string Tag { get; set; }

        /// <summary>
        /// Fixed image format
        /// </summary>
        [JsonProperty("fixed_image", DefaultValueHandling = DefaultValueHandling.Ignore)]
        public string FixedImage { get; set; }

        /// <summary>
        /// Determines if the devices is mandatory
        /// </summary>
        [JsonProperty("mandatory", DefaultValueHandling = DefaultValueHandling.Ignore)]
        public string Mandatory { get; set; } // TODO: bool?

        /// <summary>
        /// Device interface
        /// </summary>
        [JsonProperty("interface", DefaultValueHandling = DefaultValueHandling.Ignore)]
        public string Interface { get; set; }

        /// <summary>
        /// Device instances
        /// </summary>
        [JsonProperty("instances", DefaultValueHandling = DefaultValueHandling.Ignore)]
        public List<Instance> Instances { get; set; }

        /// <summary>
        /// Device extensions
        /// </summary>
        [JsonProperty("extensions", DefaultValueHandling = DefaultValueHandling.Ignore)]
        public List<Extension> Extensions { get; set; }

        #endregion

        #region Accessors

        /// <summary>
        /// Set fields with given values
        /// </summary>
        /// <param name="mappings">Mappings dictionary</param>
        public override void SetFields(Dictionary<Field, string> mappings)
        {
            // Set base fields
            base.SetFields(mappings);

            // Handle Device-specific fields
            if (mappings.Keys.Contains(Field.DatItem_DeviceType))
                DeviceType = mappings[Field.DatItem_DeviceType];

            if (mappings.Keys.Contains(Field.DatItem_Tag))
                Tag = mappings[Field.DatItem_Tag];

            if (mappings.Keys.Contains(Field.DatItem_FixedImage))
                FixedImage = mappings[Field.DatItem_FixedImage];

            if (mappings.Keys.Contains(Field.DatItem_Mandatory))
                Mandatory = mappings[Field.DatItem_Mandatory];

            if (mappings.Keys.Contains(Field.DatItem_Interface))
                Interface = mappings[Field.DatItem_Interface];

            // TODO: Handle DatItem_Instance*
            // TODO: Handle DatItem_Extension*
        }

        #endregion

        #region Constructors

        /// <summary>
        /// Create a default, empty Device object
        /// </summary>
        public Device()
        {
            ItemType = ItemType.Device;
        }

        #endregion

        #region Cloning Methods

        public override object Clone()
        {
            return new Device()
            {
                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,

                LoadFlag = this.LoadFlag,

                Machine = this.Machine.Clone() as Machine,
                Source = this.Source.Clone() as Source,
                Remove = this.Remove,

                DeviceType = this.DeviceType,
                Tag = this.Tag,
                FixedImage = this.FixedImage,
                Mandatory = this.Mandatory,
                Interface = this.Interface,
                Instances = this.Instances,
                Extensions = this.Extensions,
            };
        }

        #endregion

        #region Comparision Methods

        public override bool Equals(DatItem other)
        {
            // If we don't have a Device, return false
            if (ItemType != other.ItemType)
                return false;

            // Otherwise, treat it as a Device
            Device newOther = other as Device;

            // If the Device information matches
            return (DeviceType == newOther.DeviceType
                && Tag == newOther.Tag
                && FixedImage == newOther.FixedImage
                && Mandatory == newOther.Mandatory
                && Interface == newOther.Interface);

            // TODO: Handle DatItem_Instance*
            // TODO: Handle DatItem_Extension*
        }

        #endregion

        #region Filtering

        /// <summary>
        /// Check to see if a DatItem passes the filter
        /// </summary>
        /// <param name="filter">Filter to check against</param>
        /// <returns>True if the item passed the filter, false otherwise</returns>
        public override bool PassesFilter(Filter filter)
        {
            // Check common fields first
            if (!base.PassesFilter(filter))
                return false;

            // Filter on device type
            if (filter.DatItem_DeviceType.MatchesPositiveSet(DeviceType) == false)
                return false;
            if (filter.DatItem_DeviceType.MatchesNegativeSet(DeviceType) == true)
                return false;

            // Filter on tag
            if (filter.DatItem_Tag.MatchesPositiveSet(Tag) == false)
                return false;
            if (filter.DatItem_Tag.MatchesNegativeSet(Tag) == true)
                return false;

            // Filter on fixed image
            if (filter.DatItem_FixedImage.MatchesPositiveSet(FixedImage) == false)
                return false;
            if (filter.DatItem_FixedImage.MatchesNegativeSet(FixedImage) == true)
                return false;

            // Filter on mandatory
            if (filter.DatItem_Mandatory.MatchesPositiveSet(Mandatory) == false)
                return false;
            if (filter.DatItem_Mandatory.MatchesNegativeSet(Mandatory) == true)
                return false;

            // Filter on interface
            if (filter.DatItem_Interface.MatchesPositiveSet(Interface) == false)
                return false;
            if (filter.DatItem_Interface.MatchesNegativeSet(Interface) == true)
                return false;

            // TODO: Handle DatItem_Instance*
            // TODO: Handle DatItem_Extension*

            return true;
        }

        /// <summary>
        /// Remove fields from the DatItem
        /// </summary>
        /// <param name="fields">List of Fields to remove</param>
        public override void RemoveFields(List<Field> fields)
        {
            // Remove common fields first
            base.RemoveFields(fields);

            // Remove the fields
            if (fields.Contains(Field.DatItem_DeviceType))
                DeviceType = null;

            if (fields.Contains(Field.DatItem_Tag))
                Tag = null;

            if (fields.Contains(Field.DatItem_FixedImage))
                FixedImage = null;

            if (fields.Contains(Field.DatItem_Mandatory))
                Mandatory = null;

            if (fields.Contains(Field.DatItem_Interface))
                Interface = null;

            // TODO: Handle DatItem_Instance*
            // TODO: Handle DatItem_Extension*
        }

        #endregion

        #region Sorting and Merging

        /// <summary>
        /// Replace fields from another item
        /// </summary>
        /// <param name="item">DatItem to pull new information from</param>
        /// <param name="fields">List of Fields representing what should be updated</param>
        public override void ReplaceFields(DatItem item, List<Field> fields)
        {
            // Replace common fields first
            base.ReplaceFields(item, fields);

            // If we don't have a Device to replace from, ignore specific fields
            if (item.ItemType != ItemType.Device)
                return;

            // Cast for easier access
            Device newItem = item as Device;

            // Replace the fields
            if (fields.Contains(Field.DatItem_DeviceType))
                DeviceType = newItem.DeviceType;

            if (fields.Contains(Field.DatItem_Tag))
                Tag = newItem.Tag;

            if (fields.Contains(Field.DatItem_FixedImage))
                FixedImage = newItem.FixedImage;

            if (fields.Contains(Field.DatItem_Mandatory))
                Mandatory = newItem.Mandatory;

            if (fields.Contains(Field.DatItem_Interface))
                Interface = newItem.Interface;

            // TODO: Handle DatItem_Instance*
            // TODO: Handle DatItem_Extension*
        }

        #endregion
    }
}