Promote Extension early

This commit is contained in:
Matt Nadareski
2020-09-02 16:37:01 -07:00
parent 86173a39ec
commit 213c76ad10
7 changed files with 244 additions and 22 deletions

View File

@@ -244,6 +244,9 @@ namespace SabreTools.Library.DatFiles
case ItemType.Driver:
datItem = datItemObj.ToObject<Driver>();
break;
case ItemType.Extension:
datItem = datItemObj.ToObject<Extension>();
break;
case ItemType.Feature:
datItem = datItemObj.ToObject<Feature>();
break;

View File

@@ -1069,9 +1069,11 @@ namespace SabreTools.Library.DatFiles
switch (reader.Name)
{
case "instance":
var instance = new Instance();
instance.Name = reader.GetAttribute("name");
instance.BriefName = reader.GetAttribute("briefname");
var instance = new Instance
{
Name = reader.GetAttribute("name"),
BriefName = reader.GetAttribute("briefname"),
};
device.Instances.Add(instance);
@@ -1079,8 +1081,10 @@ namespace SabreTools.Library.DatFiles
break;
case "extension":
var extension = new Extension();
extension.Name = reader.GetAttribute("name");
var extension = new Extension
{
Name = reader.GetAttribute("name"),
};
device.Extensions.Add(extension);

View File

@@ -248,23 +248,6 @@ namespace SabreTools.Library.DatItems
#endregion
}
/// <summary>
/// Represents one ListXML extension
/// </summary>
[JsonObject("extension")]
public class Extension
{
#region Fields
/// <summary>
/// Extension name
/// </summary>
[JsonProperty("name", DefaultValueHandling = DefaultValueHandling.Ignore)]
public string Name { get; set; }
#endregion
}
/// <summary>
/// Represents one ListXML input
/// </summary>

View File

@@ -491,6 +491,9 @@ namespace SabreTools.Library.DatItems
case ItemType.Driver:
return new Driver();
case ItemType.Extension:
return new Extension();
case ItemType.Feature:
return new Feature();
@@ -536,6 +539,7 @@ namespace SabreTools.Library.DatItems
ItemType.DipSwitch => new DipSwitch(),
ItemType.Disk => new Disk(),
ItemType.Driver => new Driver(),
ItemType.Extension => new Extension(),
ItemType.Feature => new Feature(),
ItemType.Media => new Media(),
ItemType.RamOption => new RamOption(),

View File

@@ -495,6 +495,7 @@ namespace SabreTools.Library.DatItems
DeviceReference,
DipSwitch,
Driver,
Extension,
Feature,
RamOption,
Release,

View File

@@ -0,0 +1,221 @@
using System.Collections.Generic;
using System.IO;
using System.Linq;
using SabreTools.Library.Filtering;
using SabreTools.Library.Tools;
using Newtonsoft.Json;
namespace SabreTools.Library.DatItems
{
/// <summary>
/// Represents a matchable extension
/// </summary>
[JsonObject("extension")]
public class Extension : DatItem
{
#region Fields
/// <summary>
/// Name of the item
/// </summary>
[JsonProperty("name")]
public string Name { 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 Sample-specific fields
if (mappings.Keys.Contains(Field.DatItem_Name))
Name = mappings[Field.DatItem_Name];
}
#endregion
#region Constructors
/// <summary>
/// Create a default, empty Extension object
/// </summary>
public Extension()
{
Name = string.Empty;
ItemType = ItemType.Extension;
}
#endregion
#region Cloning Methods
public override object Clone()
{
return new Extension()
{
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,
};
}
#endregion
#region Comparision Methods
public override bool Equals(DatItem other)
{
// If we don't have a Extension, return false
if (ItemType != other.ItemType)
return false;
// Otherwise, treat it as a Extension
Extension newOther = other as Extension;
// If the Extension information matches
return (Name == newOther.Name);
}
#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;
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;
}
/// <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 Extension to replace from, ignore specific fields
if (item.ItemType != ItemType.Extension)
return;
// Cast for easier access
Extension newItem = item as Extension;
// Replace the fields
if (fields.Contains(Field.DatItem_Name))
Name = newItem.Name;
}
#endregion
}
}

View File

@@ -1680,6 +1680,8 @@ namespace SabreTools.Library.Tools
return ItemType.Disk;
case "driver":
return ItemType.Driver;
case "extension":
return ItemType.Extension;
case "feature":
return ItemType.Feature;
case "media":
@@ -1716,6 +1718,7 @@ namespace SabreTools.Library.Tools
"dipswitch" => ItemType.DipSwitch,
"disk" => ItemType.Disk,
"driver" => ItemType.Driver,
"extension" => ItemType.Extension,
"feature" => ItemType.Feature,
"media" => ItemType.Media,
"ramoption" => ItemType.RamOption,
@@ -2291,6 +2294,8 @@ namespace SabreTools.Library.Tools
return "disk";
case ItemType.Driver:
return "driver";
case ItemType.Extension:
return "extension";
case ItemType.Feature:
return "feature";
case ItemType.Media:
@@ -2327,6 +2332,7 @@ namespace SabreTools.Library.Tools
ItemType.DipSwitch => "dipswitch",
ItemType.Disk => "disk",
ItemType.Driver => "driver",
ItemType.Extension => "extension",
ItemType.Feature => "feature",
ItemType.Media => "media",
ItemType.RamOption => "ramoption",