using System.Collections.Generic;
using System.Linq;
#if NET40_OR_GREATER || NETCOREAPP
using System.Threading.Tasks;
#endif
using SabreTools.Core;
using SabreTools.Core.Filter;
using SabreTools.Core.Tools;
using SabreTools.DatFiles;
using SabreTools.DatItems;
using SabreTools.DatItems.Formats;
using SabreTools.Logging;
namespace SabreTools.Filtering
{
///
/// Represents the removal operations that need to be performed on a set of items, usually a DAT
///
public class Remover
{
#region Fields
///
/// List of header fields to exclude from writing
///
public List HeaderFieldNames { get; } = [];
///
/// List of machine fields to exclude from writing
///
public List MachineFieldNames { get; } = [];
///
/// List of fields to exclude from writing
///
public Dictionary> ItemFieldNames { get; } = [];
#endregion
#region Logging
///
/// Logging object
///
protected Logger logger;
#endregion
#region Constructors
///
/// Constructor
///
public Remover()
{
logger = new Logger(this);
}
#endregion
#region Population
///
/// Populate the exclusion objects using a field name
///
/// Field name
public void PopulateExclusions(string field)
=> PopulateExclusionsFromList([field]);
///
/// Populate the exclusion objects using a set of field names
///
/// List of field names
public void PopulateExclusionsFromList(List? fields)
{
// If the list is null or empty, just return
if (fields == null || fields.Count == 0)
return;
var watch = new InternalStopwatch("Populating removals from list");
foreach (string field in fields)
{
bool removerSet = SetRemover(field);
if (!removerSet)
logger.Warning($"The value {field} did not match any known field names. Please check the wiki for more details on supported field names.");
}
watch.Stop();
}
///
/// Set remover from a value
///
/// Key for the remover to be set
private bool SetRemover(string field)
{
// If the key is null or empty, return false
if (string.IsNullOrEmpty(field))
return false;
// Get the parser pair out of it, if possible
(string? type, string? key) = FilterParser.ParseFilterId(field);
if (type == null || key == null)
return false;
switch (type)
{
case Models.Metadata.MetadataFile.HeaderKey:
HeaderFieldNames.Add(key);
return true;
case Models.Metadata.MetadataFile.MachineKey:
MachineFieldNames.Add(key);
return true;
default:
if (!ItemFieldNames.ContainsKey(type))
ItemFieldNames[type] = [];
ItemFieldNames[type].Add(key);
return true;
}
}
#endregion
#region Running
///
/// Remove fields from a DatFile
///
/// Current DatFile object to run operations on
public void ApplyRemovals(DatFile datFile)
{
InternalStopwatch watch = new("Applying removals to DAT");
// Remove DatHeader fields
if (HeaderFieldNames.Any())
RemoveFields(datFile.Header);
// Remove DatItem and Machine fields
if (MachineFieldNames.Any() || ItemFieldNames.Any())
{
#if NET452_OR_GREATER || NETCOREAPP
Parallel.ForEach(datFile.Items.Keys, Globals.ParallelOptions, key =>
#elif NET40_OR_GREATER
Parallel.ForEach(datFile.Items.Keys, key =>
#else
foreach (var key in datFile.Items.Keys)
#endif
{
ConcurrentList? items = datFile.Items[key];
if (items == null)
#if NET40_OR_GREATER || NETCOREAPP
return;
#else
continue;
#endif
for (int j = 0; j < items.Count; j++)
{
RemoveFields(items[j]);
}
datFile.Items.Remove(key);
datFile.Items.AddRange(key, items);
#if NET40_OR_GREATER || NETCOREAPP
});
#else
}
#endif
}
watch.Stop();
}
///
/// Remove fields with given values
///
/// DatHeader to remove fields from
public void RemoveFields(DatHeader datHeader)
{
// If we have an invalid input, return
if (datHeader == null || !HeaderFieldNames.Any())
return;
foreach (var fieldName in HeaderFieldNames)
{
datHeader.RemoveField(fieldName);
}
}
///
/// Remove fields with given values
///
/// Machine to remove fields from
public void RemoveFields(Machine? machine)
{
// If we have an invalid input, return
if (machine == null || !MachineFieldNames.Any())
return;
foreach (var fieldName in MachineFieldNames)
{
machine.RemoveField(fieldName);
}
}
///
/// Remove fields with given values
///
/// DatItem to remove fields from
public void RemoveFields(DatItem? datItem)
{
if (datItem == null)
return;
#region Common
// Handle Machine fields
if (MachineFieldNames.Any() && datItem.GetFieldValue(DatItem.MachineKey) != null)
RemoveFields(datItem.GetFieldValue(DatItem.MachineKey));
// If there are no field names, return
if (ItemFieldNames == null || !ItemFieldNames.Any())
return;
// If there are no field names for this type or generic, return
string? itemType = datItem.GetStringFieldValue(Models.Metadata.DatItem.TypeKey).AsEnumValue().AsStringValue();
if (itemType == null || (!ItemFieldNames.ContainsKey(itemType) && !ItemFieldNames.ContainsKey("item")))
return;
// Get the combined list of fields to remove
var fieldNames = new List();
if (ItemFieldNames.ContainsKey(itemType))
fieldNames.AddRange(ItemFieldNames[itemType]);
if (ItemFieldNames.ContainsKey("item"))
fieldNames.AddRange(ItemFieldNames["item"]);
fieldNames = fieldNames.Distinct().ToList();
// If the field specifically contains Name, set it separately
if (fieldNames.Contains(Models.Metadata.Rom.NameKey))
datItem.SetName(null);
#endregion
#region Item-Specific
// Handle unnested removals first
foreach (var datItemField in fieldNames)
{
datItem.RemoveField(datItemField);
}
// Handle nested removals
switch (datItem)
{
case Adjuster adjuster: RemoveFields(adjuster); break;
case Configuration configuration: RemoveFields(configuration); break;
case ConfSetting confSetting: RemoveFields(confSetting); break;
case Device device: RemoveFields(device); break;
case DipSwitch dipSwitch: RemoveFields(dipSwitch); break;
case DipValue dipValue: RemoveFields(dipValue); break;
case Disk disk: RemoveFields(disk); break;
case Input input: RemoveFields(input); break;
case Part part: RemoveFields(part); break;
case Port port: RemoveFields(port); break;
case Rom rom: RemoveFields(rom); break;
case Slot slot: RemoveFields(slot); break;
}
#endregion
}
///
/// Remove fields with given values
///
/// Adjuster to remove fields from
private void RemoveFields(Adjuster adjuster)
{
if (!adjuster.ConditionsSpecified)
return;
foreach (Condition subCondition in adjuster.GetFieldValue(Models.Metadata.Adjuster.ConditionKey)!)
{
RemoveFields(subCondition);
}
}
///
/// Remove fields with given values
///
/// Configuration to remove fields from
private void RemoveFields(Configuration configuration)
{
if (configuration.ConditionsSpecified)
{
foreach (Condition subCondition in configuration.GetFieldValue(Models.Metadata.Configuration.ConditionKey)!)
{
RemoveFields(subCondition);
}
}
if (configuration.LocationsSpecified)
{
foreach (ConfLocation subLocation in configuration.GetFieldValue(Models.Metadata.Configuration.ConfLocationKey)!)
{
RemoveFields(subLocation);
}
}
if (configuration.SettingsSpecified)
{
foreach (ConfSetting subSetting in configuration.GetFieldValue(Models.Metadata.Configuration.ConfSettingKey)!)
{
RemoveFields(subSetting as DatItem);
}
}
}
///
/// Remove fields with given values
///
/// ConfSetting to remove fields from
private void RemoveFields(ConfSetting confsetting)
{
if (confsetting.ConditionsSpecified)
{
foreach (Condition subCondition in confsetting.GetFieldValue(Models.Metadata.ConfSetting.ConditionKey)!)
{
RemoveFields(subCondition);
}
}
}
///
/// Remove fields with given values
///
/// Device to remove fields from
private void RemoveFields(Device device)
{
if (device.ExtensionsSpecified)
{
foreach (Extension subExtension in device.GetFieldValue(Models.Metadata.Device.ExtensionKey)!)
{
RemoveFields(subExtension);
}
}
if (device.InstancesSpecified)
{
foreach (Instance subInstance in device.GetFieldValue(Models.Metadata.Device.InstanceKey)!)
{
RemoveFields(subInstance);
}
}
}
///
/// Remove fields with given values
///
/// DipSwitch to remove fields from
private void RemoveFields(DipSwitch dipSwitch)
{
if (dipSwitch.ConditionsSpecified)
{
foreach (Condition subCondition in dipSwitch.GetFieldValue(Models.Metadata.DipSwitch.ConditionKey)!)
{
RemoveFields(subCondition);
}
}
if (dipSwitch.LocationsSpecified)
{
foreach (DipLocation subLocation in dipSwitch.GetFieldValue(Models.Metadata.DipSwitch.DipLocationKey)!)
{
RemoveFields(subLocation);
}
}
if (dipSwitch.ValuesSpecified)
{
foreach (DipValue subValue in dipSwitch.GetFieldValue(Models.Metadata.DipSwitch.DipValueKey)!)
{
RemoveFields(subValue as DatItem);
}
}
if (dipSwitch.PartSpecified)
RemoveFields(dipSwitch.GetFieldValue(DipSwitch.PartKey)! as DatItem);
}
///
/// Remove fields with given values
///
/// DipValue to remove fields from
private void RemoveFields(DipValue dipValue)
{
if (dipValue.ConditionsSpecified)
{
foreach (Condition subCondition in dipValue.GetFieldValue(Models.Metadata.DipValue.ConditionKey)!)
{
RemoveFields(subCondition);
}
}
}
///
/// Remove fields with given values
///
/// Disk to remove fields from
private void RemoveFields(Disk disk)
{
if (disk.DiskAreaSpecified)
RemoveFields(disk.GetFieldValue(Disk.DiskAreaKey)! as DatItem);
if (disk.PartSpecified)
RemoveFields(disk.GetFieldValue(Disk.PartKey)! as DatItem);
}
///
/// Remove fields with given values
///
/// Input to remove fields from
private void RemoveFields(Input input)
{
if (input.ControlsSpecified)
{
foreach (Control subControl in input.GetFieldValue(Models.Metadata.Input.ControlKey)!)
{
RemoveFields(subControl);
}
}
}
///
/// Remove fields with given values
///
/// Part to remove fields from
private void RemoveFields(Part part)
{
if (part.FeaturesSpecified)
{
foreach (PartFeature subPartFeature in part.GetFieldValue(Models.Metadata.Part.FeatureKey)!)
{
RemoveFields(subPartFeature);
}
}
}
///
/// Remove fields with given values
///
/// Port to remove fields from
private void RemoveFields(Port port)
{
if (port.AnalogsSpecified)
{
foreach (Analog subAnalog in port.GetFieldValue(Models.Metadata.Port.AnalogKey)!)
{
RemoveFields(subAnalog);
}
}
}
///
/// Remove fields with given values
///
/// Rom to remove fields from
private void RemoveFields(Rom rom)
{
if (rom.DataAreaSpecified)
RemoveFields(rom.GetFieldValue(Rom.DataAreaKey)!);
if (rom.PartSpecified)
RemoveFields(rom.GetFieldValue(Rom.PartKey)! as DatItem);
}
///
/// Remove fields with given values
///
/// Slot to remove fields from
private void RemoveFields(Slot slot)
{
if (slot.SlotOptionsSpecified)
{
foreach (SlotOption subSlotOption in slot.GetFieldValue(Models.Metadata.Slot.SlotOptionKey)!)
{
RemoveFields(subSlotOption);
}
}
}
#endregion
}
}