Promote SharedFeature

This commit is contained in:
Matt Nadareski
2020-09-03 00:48:07 -07:00
parent 995871174d
commit 8a2e840a83
11 changed files with 311 additions and 152 deletions

View File

@@ -13,27 +13,6 @@ using SabreTools.Library.Tools;
/// </summary>
namespace SabreTools.Library.DatItems
{
#region Machine
#region SoftwareList
/// <summary>
/// Represents one SoftwareList shared feature object
/// </summary>
[JsonObject("sharedfeat")]
public class SharedFeature
{
[JsonProperty("name")]
public string Name { get; set; }
[JsonProperty("value")]
public string Value { get; set; }
}
#endregion
#endregion // Machine
#region DatItem
#region OpenMSX

View File

@@ -349,7 +349,6 @@ namespace SabreTools.Library.DatItems
// SoftwareList
Field.Machine_Supported,
Field.Machine_SharedFeatures,
};
#endregion
@@ -538,6 +537,9 @@ namespace SabreTools.Library.DatItems
case ItemType.Setting:
return new Setting();
case ItemType.SharedFeature:
return new SharedFeature();
case ItemType.Slot:
return new Slot();
@@ -581,6 +583,7 @@ namespace SabreTools.Library.DatItems
ItemType.Release => new Release(),
ItemType.Rom => new Rom(),
ItemType.Sample => new Sample(),
ItemType.SharedFeature => new SharedFeature(),
ItemType.Slot => new Slot(),
ItemType.SlotOption => new SlotOption(),
ItemType.SoftwareList => new SoftwareList(),

View File

@@ -221,11 +221,6 @@ namespace SabreTools.Library.DatItems
Machine_Supported,
// SharedFeatures
Machine_SharedFeatures, // TODO: Fix usage of SharedFeatures
Machine_SharedFeature_Name,
Machine_SharedFeature_Value,
#endregion
#endregion // Machine
@@ -425,6 +420,9 @@ namespace SabreTools.Library.DatItems
// Release
DatItem_Language,
// SharedFeature
DatItem_SharedFeatureValue,
// Slot.SlotOptions
DatItem_SlotOptions,
DatItem_SlotOption_Name,
@@ -498,6 +496,7 @@ namespace SabreTools.Library.DatItems
Release,
Sample,
Setting,
SharedFeature,
Slot,
SlotOption,
SoftwareList,

View File

@@ -259,12 +259,6 @@ namespace SabreTools.Library.DatItems
[JsonProperty("supported", DefaultValueHandling = DefaultValueHandling.Ignore)]
public Supported Supported { get; set; } = Supported.NULL;
/// <summary>
/// List of shared feature items
/// </summary>
[JsonProperty("sharedfeat", DefaultValueHandling = DefaultValueHandling.Ignore)]
public List<SharedFeature> SharedFeatures { get; set; } = null;
#endregion
#endregion
@@ -515,7 +509,6 @@ namespace SabreTools.Library.DatItems
#region SoftwareList
Supported = this.Supported,
SharedFeatures = this.SharedFeatures,
#endregion
};
@@ -782,54 +775,6 @@ namespace SabreTools.Library.DatItems
if (filter.Machine_Supported.MatchesNegative(Supported.NULL, Supported) == true)
return false;
#region SharedFeatures
// Machine_SharedFeatures
if (filter.Machine_SharedFeatures.MatchesNeutral(null, SharedFeatures?.Any() ?? false) == false)
return false;
// Machine_SharedFeature_Name
if (SharedFeatures?.Any() == true)
{
bool anyPositive = false;
bool anyNegative = false;
foreach (var sharedFeature in SharedFeatures)
{
if (filter.Machine_SharedFeature_Name.MatchesPositiveSet(sharedFeature?.Name) != false)
anyPositive = true;
if (filter.Machine_SharedFeature_Name.MatchesNegativeSet(sharedFeature?.Name) == true)
anyNegative = true;
}
if (!anyPositive)
return false;
if (anyNegative)
return false;
}
// Machine_SharedFeature_Value
if (SharedFeatures?.Any() == true)
{
bool anyPositive = false;
bool anyNegative = false;
foreach (var sharedFeature in SharedFeatures)
{
if (filter.Machine_SharedFeature_Value.MatchesPositiveSet(sharedFeature?.Value) != false)
anyPositive = true;
if (filter.Machine_SharedFeature_Value.MatchesNegativeSet(sharedFeature?.Value) == true)
anyNegative = true;
}
if (!anyPositive)
return false;
if (anyNegative)
return false;
}
#endregion
#endregion // SoftwareList
return true;
@@ -973,9 +918,6 @@ namespace SabreTools.Library.DatItems
if (fields.Contains(Field.Machine_Supported))
Supported = Supported.NULL;
if (fields.Contains(Field.Machine_SharedFeatures))
SharedFeatures = null;
#endregion
}
@@ -1126,9 +1068,6 @@ namespace SabreTools.Library.DatItems
if (fields.Contains(Field.Machine_Supported))
Supported = machine.Supported;
if (fields.Contains(Field.Machine_SharedFeatures))
SharedFeatures = machine.SharedFeatures;
#endregion
}

View File

@@ -0,0 +1,243 @@
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
{
/// <summary>
/// Represents one shared feature object
/// </summary>
[JsonObject("sharedfeat")]
public class SharedFeature : DatItem
{
#region Fields
/// <summary>
/// Name of the item
/// </summary>
[JsonProperty("name")]
public string Name { get; set; }
/// <summary>
/// SharedFeature value
/// </summary>
[JsonProperty("value")]
public string SharedFeatureValue { get; set; }
#endregion
#region Accessors
/// <summary>
/// Gets the name to use for a DatItem
/// </summary>
/// <returns>Name if available, null otherwise</returns>
public override string GetName()
{
return Name;
}
/// <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 SharedFeature-specific fields
if (mappings.Keys.Contains(Field.DatItem_Name))
Name = mappings[Field.DatItem_Name];
if (mappings.Keys.Contains(Field.DatItem_SharedFeatureValue))
SharedFeatureValue = mappings[Field.DatItem_SharedFeatureValue];
}
#endregion
#region Constructors
/// <summary>
/// Create a default, empty SharedFeature object
/// </summary>
public SharedFeature()
{
Name = string.Empty;
ItemType = ItemType.SharedFeature;
}
#endregion
#region Cloning Methods
public override object Clone()
{
return new SharedFeature()
{
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,
SharedFeatureValue = this.SharedFeatureValue,
};
}
#endregion
#region Comparision Methods
public override bool Equals(DatItem other)
{
// If we don't have a sample, return false
if (ItemType != other.ItemType)
return false;
// Otherwise, treat it as a SharedFeature
SharedFeature newOther = other as SharedFeature;
// If the archive information matches
return (Name == newOther.Name && SharedFeatureValue == newOther.SharedFeatureValue);
}
#endregion
#region Filtering
/// <summary>
/// Clean a DatItem according to the cleaner
/// </summary>
/// <param name="cleaner">Cleaner to implement</param>
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;
}
}
}
/// <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 item name
if (filter.DatItem_Name.MatchesPositiveSet(Name) == false)
return false;
if (filter.DatItem_Name.MatchesNegativeSet(Name) == true)
return false;
// Filter on info value
if (filter.DatItem_SharedFeatureValue.MatchesPositiveSet(SharedFeatureValue) == false)
return false;
if (filter.DatItem_SharedFeatureValue.MatchesNegativeSet(SharedFeatureValue) == true)
return false;
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_Name))
Name = null;
if (fields.Contains(Field.DatItem_SharedFeatureValue))
SharedFeatureValue = null;
}
/// <summary>
/// Set internal names to match One Rom Per Game (ORPG) logic
/// </summary>
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
/// <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 SharedFeature to replace from, ignore specific fields
if (item.ItemType != ItemType.SharedFeature)
return;
// Cast for easier access
SharedFeature newItem = item as SharedFeature;
// Replace the fields
if (fields.Contains(Field.DatItem_Name))
Name = newItem.Name;
if (fields.Contains(Field.DatItem_SharedFeatureValue))
SharedFeatureValue = newItem.SharedFeatureValue;
}
#endregion
}
}