claunia/SabreTools
1
0
Fork 0
mirror of https://github.com/claunia/SabreTools.git synced 2025-12-16 19:14:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup usings, promote PartFeature

Browse Source
This commit is contained in:
Matt Nadareski
2020-09-03 13:20:56 -07:00
parent 10de9f3430
commit 5d01d4ab51
15 changed files with 268 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
SabreTools.Library/DatFiles/ItemDictionary.cs
View File

@@ -179,6 +179,12 @@ namespace SabreTools.Library.DatFiles
[JsonIgnore]
public long MediaCount { get; private set; } = 0;
/// <summary>
/// Number of PartFeature items
/// </summary>
[JsonIgnore]
public long PartFeatureCount { get; private set; } = 0;
/// <summary>
/// Number of Port items
/// </summary>
@@ -623,6 +629,9 @@ namespace SabreTools.Library.DatFiles
SHA1Count += (string.IsNullOrWhiteSpace((item as Media).SHA1) ? 0 : 1);
SHA256Count += (string.IsNullOrWhiteSpace((item as Media).SHA256) ? 0 : 1);
break;
case ItemType.PartFeature:
PartFeatureCount++;
break;
case ItemType.Port:
PortCount++;
break;
@@ -806,6 +815,9 @@ namespace SabreTools.Library.DatFiles
SHA1Count -= (string.IsNullOrWhiteSpace((item as Media).SHA1) ? 0 : 1);
SHA256Count -= (string.IsNullOrWhiteSpace((item as Media).SHA256) ? 0 : 1);
break;
case ItemType.PartFeature:
PartFeatureCount--;
break;
case ItemType.Port:
PortCount--;
break;

3
SabreTools.Library/DatFiles/Json.cs
View File

@@ -274,6 +274,9 @@ namespace SabreTools.Library.DatFiles
case ItemType.Media:
datItem = datItemObj.ToObject<Media>();
break;
case ItemType.PartFeature:
datItem = datItemObj.ToObject<PartFeature>();
break;
case ItemType.Port:
datItem = datItemObj.ToObject<Port>();
break;

16
SabreTools.Library/DatItems/Auxiliary.cs
View File

@@ -4,9 +4,9 @@ using System.Linq;
using SabreTools.Library.DatItems;
using SabreTools.Library.Filtering;
using SabreTools.Library.Tools;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using SabreTools.Library.Tools;
/// <summary>
/// This holds all of the auxiliary types needed for proper parsing
@@ -103,20 +103,6 @@ namespace SabreTools.Library.DatItems
public List<PartFeature> Features { get; set; }
}
/// <summary>
/// Represents one SoftwareList feature object
/// </summary>
/// TODO: Promote this to DatItem
[JsonObject("part_feature")]
public class PartFeature
{
[JsonProperty("name")]
public string Name { get; set; }
[JsonProperty("value")]
public string Value { get; set; }
}
#endregion
#endregion //DatItem

4
SabreTools.Library/DatItems/DatItem.cs
View File

@@ -355,6 +355,9 @@ namespace SabreTools.Library.DatItems
case ItemType.Media:
return new Media();
case ItemType.PartFeature:
return new PartFeature();
case ItemType.Port:
return new Port();
@@ -414,6 +417,7 @@ namespace SabreTools.Library.DatItems
ItemType.Instance => new Instance(),
ItemType.Location => new Location(),
ItemType.Media => new Media(),
ItemType.PartFeature => new PartFeature(),
ItemType.Port => new Port(),
ItemType.RamOption => new RamOption(),
ItemType.Release => new Release(),

3
SabreTools.Library/DatItems/Display.cs
View File

@@ -1,8 +1,9 @@
using System.Collections.Generic;
using System.Linq;
using SabreTools.Library.Filtering;
using Newtonsoft.Json;
using SabreTools.Library.Tools;
using Newtonsoft.Json;
namespace SabreTools.Library.DatItems
{

1
SabreTools.Library/DatItems/Enums.cs
View File

@@ -483,6 +483,7 @@ namespace SabreTools.Library.DatItems
Input,
Instance,
Location,
PartFeature,
Port,
RamOption,
Release,

3
SabreTools.Library/DatItems/Info.cs
View File

@@ -1,9 +1,10 @@
using System.Collections.Generic;
using System.IO;
using System.Linq;
using SabreTools.Library.Filtering;
using Newtonsoft.Json;
using SabreTools.Library.Tools;
using Newtonsoft.Json;
namespace SabreTools.Library.DatItems
{

3
SabreTools.Library/DatItems/Input.cs
View File

@@ -1,8 +1,9 @@
using System.Collections.Generic;
using System.Linq;
using SabreTools.Library.Filtering;
using Newtonsoft.Json;
using SabreTools.Library.Tools;
using Newtonsoft.Json;
namespace SabreTools.Library.DatItems
{

3
SabreTools.Library/DatItems/Location.cs
View File

@@ -1,9 +1,10 @@
using System.Collections.Generic;
using System.IO;
using System.Linq;
using SabreTools.Library.Filtering;
using Newtonsoft.Json;
using SabreTools.Library.Tools;
using Newtonsoft.Json;
namespace SabreTools.Library.DatItems
{

226
SabreTools.Library/DatItems/PartFeature.cs Normal file
View File

@@ -0,0 +1,226 @@
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 one part feature object
/// </summary>
[JsonObject("part_feature")]
public class PartFeature : DatItem
{
#region Fields
/// <summary>
/// Name of the item
/// </summary>
[JsonProperty("name")]
public string Name { get; set; }
/// <summary>
/// PartFeature value
/// </summary>
[JsonProperty("value")]
public string Value { 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 PartFeature-specific fields
if (mappings.Keys.Contains(Field.DatItem_Name))
Name = mappings[Field.DatItem_Name];
if (mappings.Keys.Contains(Field.DatItem_Value))
Value = mappings[Field.DatItem_Value];
}
#endregion
#region Constructors
/// <summary>
/// Create a default, empty PartFeature object
/// </summary>
public PartFeature()
{
Name = string.Empty;
ItemType = ItemType.PartFeature;
}
#endregion
#region Cloning Methods
public override object Clone()
{
return new PartFeature()
{
ItemType = this.ItemType,
DupeType = this.DupeType,
Machine = this.Machine.Clone() as Machine,
Source = this.Source.Clone() as Source,
Remove = this.Remove,
Name = this.Name,
Value = this.Value,
};
}
#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 PartFeature
PartFeature newOther = other as PartFeature;
// If the archive information matches
return (Name == newOther.Name && Value == newOther.Value);
}
#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_Value.MatchesPositiveSet(Value) == false)
return false;
if (filter.DatItem_Value.MatchesNegativeSet(Value) == 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_Value))
Value = 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 PartFeature to replace from, ignore specific fields
if (item.ItemType != ItemType.PartFeature)
return;
// Cast for easier access
PartFeature newItem = item as PartFeature;
// Replace the fields
if (fields.Contains(Field.DatItem_Name))
Name = newItem.Name;
if (fields.Contains(Field.DatItem_Value))
Value = newItem.Value;
}
#endregion
}
}

2
SabreTools.Library/DatItems/Port.cs
View File

@@ -1,9 +1,7 @@
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

3
SabreTools.Library/DatItems/SharedFeature.cs
View File

@@ -1,9 +1,10 @@
using System.Collections.Generic;
using System.IO;
using System.Linq;
using SabreTools.Library.Filtering;
using Newtonsoft.Json;
using SabreTools.Library.Tools;
using Newtonsoft.Json;
namespace SabreTools.Library.DatItems
{

3
SabreTools.Library/DatItems/SlotOption.cs
View File

@@ -1,9 +1,10 @@
using System.Collections.Generic;
using System.IO;
using System.Linq;
using SabreTools.Library.Filtering;
using Newtonsoft.Json;
using SabreTools.Library.Tools;
using Newtonsoft.Json;
namespace SabreTools.Library.DatItems
{

2
SabreTools.Library/Filtering/Filter.cs
View File

@@ -11,9 +11,9 @@ namespace SabreTools.Library.Filtering
/// Represents the filtering operations that need to be performed on a set of items, usually a DAT
/// </summary>
/// TODO: Can clever use of Filtering allow for easier external splitting methods?
/// TODO: Field name for filter population needs to be overhauled
public class Filter
{
// TODO: Reorder once all reorganization is done
#region Fields
#region Machine Filters

8
SabreTools.Library/Tools/Converters.cs
View File

@@ -1650,6 +1650,9 @@ namespace SabreTools.Library.Tools
return ItemType.Location;
case "media":
return ItemType.Media;
case "partfeature":
case "part_feature":
return ItemType.PartFeature;
case "port":
return ItemType.Port;
case "ramoption":
@@ -1700,6 +1703,8 @@ namespace SabreTools.Library.Tools
"instance" => ItemType.Instance,
"location" => ItemType.Location,
"media" => ItemType.Media,
"partfeature" => ItemType.PartFeature,
"part_feature" => ItemType.PartFeature,
"port" => ItemType.Port,
"ramoption" => ItemType.RamOption,
"release" => ItemType.Release,
@@ -2297,6 +2302,8 @@ namespace SabreTools.Library.Tools
return "location";
case ItemType.Media:
return "media";
case ItemType.PartFeature:
return "part_feature";
case ItemType.Port:
return "port";
case ItemType.RamOption:
@@ -2347,6 +2354,7 @@ namespace SabreTools.Library.Tools
ItemType.Instance => "instance",
ItemType.Location => "location",
ItemType.Media => "media",
ItemType.PartFeature => "part_feature",
ItemType.Port => "port",
ItemType.RamOption => "ramoption",
ItemType.Release => "release",