using System;
using System.Xml.Serialization;
using Newtonsoft.Json;
using SabreTools.Core;
using SabreTools.Core.Filter;
using SabreTools.Core.Tools;
namespace SabreTools.DatFiles
{
///
/// Represents all possible DAT header information
///
[JsonObject("header"), XmlRoot("header")]
public sealed class DatHeader : ModelBackedItem, ICloneable
{
#region Constants
///
/// Add a new extension to all items
///
public const string AddExtensionKey = "ADDEXTENSION";
///
/// Read or write format
///
public const string DatFormatKey = "DATFORMAT";
///
/// External name of the DAT
///
public const string FileNameKey = "FILENAME";
///
/// Output the machine name
///
public const string GameNameKey = "GAMENAME";
///
/// Input depot information
///
public const string InputDepotKey = "INPUTDEPOT";
///
/// Output depot information
///
public const string OutputDepotKey = "OUTPUTDEPOT";
///
/// Text to append to all outputted lines
///
public const string PostfixKey = "POSTFIX";
///
/// Text to prepend to all outputted lines
///
public const string PrefixKey = "PREFIX";
///
/// Wrap quotes around the entire line, sans prefix and postfix
///
public const string QuotesKey = "QUOTES";
///
/// Remove all item extensions
///
public const string RemoveExtensionKey = "REMOVEEXTENSION";
///
/// Replace all item extensions
///
public const string ReplaceExtensionKey = "REPLACEEXTENSION";
///
/// Output the item name
///
public const string UseRomNameKey = "USEROMNAME";
#endregion
#region Fields
[JsonIgnore]
public bool CanOpenSpecified
{
get
{
var canOpen = GetStringArrayFieldValue(Models.Metadata.Header.CanOpenKey);
return canOpen != null && canOpen.Length > 0;
}
}
[JsonIgnore]
public bool ImagesSpecified
{
get
{
return GetFieldValue(Models.Metadata.Header.ImagesKey) != null;
}
}
[JsonIgnore]
public bool InfosSpecified
{
get
{
return GetFieldValue(Models.Metadata.Header.InfosKey) != null;
}
}
[JsonIgnore]
public bool NewDatSpecified
{
get
{
return GetFieldValue(Models.Metadata.Header.NewDatKey) != null;
}
}
[JsonIgnore]
public bool SearchSpecified
{
get
{
return GetFieldValue(Models.Metadata.Header.SearchKey) != null;
}
}
#endregion
#region Constructors
public DatHeader() { }
public DatHeader(Models.Metadata.Header header)
{
// Get all fields to automatically copy without processing
var nonItemFields = TypeHelper.GetConstants(typeof(Models.Metadata.Header));
if (nonItemFields == null)
return;
// Populate the internal machine from non-filter fields
_internal = new Models.Metadata.Header();
foreach (string fieldName in nonItemFields)
{
if (header.ContainsKey(fieldName))
_internal[fieldName] = header[fieldName];
}
// Get all fields specific to the DatFiles implementation
var nonStandardFields = TypeHelper.GetConstants(typeof(DatHeader));
if (nonStandardFields == null)
return;
// Populate the internal machine from filter fields
foreach (string fieldName in nonStandardFields)
{
if (header.ContainsKey(fieldName))
_internal[fieldName] = header[fieldName];
}
}
#endregion
#region Cloning Methods
///
/// Clone the current header
///
public object Clone() => new DatHeader(GetInternalClone());
///
/// Clone the standard parts of the current header
///
public DatHeader CloneStandard()
{
var header = new DatHeader();
header.SetFieldValue(Models.Metadata.Header.AuthorKey,
GetStringFieldValue(Models.Metadata.Header.AuthorKey));
header.SetFieldValue(Models.Metadata.Header.CategoryKey,
GetStringFieldValue(Models.Metadata.Header.CategoryKey));
header.SetFieldValue(Models.Metadata.Header.CommentKey,
GetStringFieldValue(Models.Metadata.Header.CommentKey));
header.SetFieldValue(Models.Metadata.Header.DateKey,
GetStringFieldValue(Models.Metadata.Header.DateKey));
header.SetFieldValue(DatHeader.DatFormatKey,
GetFieldValue(DatHeader.DatFormatKey));
header.SetFieldValue(Models.Metadata.Header.DescriptionKey,
GetStringFieldValue(Models.Metadata.Header.DescriptionKey));
header.SetFieldValue(Models.Metadata.Header.EmailKey,
GetStringFieldValue(Models.Metadata.Header.EmailKey));
header.SetFieldValue(DatHeader.FileNameKey,
GetStringFieldValue(DatHeader.FileNameKey));
header.SetFieldValue(Models.Metadata.Header.ForceMergingKey,
GetStringFieldValue(Models.Metadata.Header.ForceMergingKey).AsEnumValue().AsStringValue());
header.SetFieldValue(Models.Metadata.Header.ForceNodumpKey,
GetStringFieldValue(Models.Metadata.Header.ForceNodumpKey).AsEnumValue().AsStringValue());
header.SetFieldValue(Models.Metadata.Header.ForcePackingKey,
GetStringFieldValue(Models.Metadata.Header.ForcePackingKey).AsEnumValue().AsStringValue());
header.SetFieldValue(Models.Metadata.Header.HeaderKey,
GetStringFieldValue(Models.Metadata.Header.HeaderKey));
header.SetFieldValue(Models.Metadata.Header.HomepageKey,
GetStringFieldValue(Models.Metadata.Header.HomepageKey));
header.SetFieldValue(Models.Metadata.Header.NameKey,
GetStringFieldValue(Models.Metadata.Header.NameKey));
header.SetFieldValue(Models.Metadata.Header.RootDirKey,
GetStringFieldValue(Models.Metadata.Header.RootDirKey));
header.SetFieldValue(Models.Metadata.Header.TypeKey,
GetStringFieldValue(Models.Metadata.Header.TypeKey));
header.SetFieldValue(Models.Metadata.Header.UrlKey,
GetStringFieldValue(Models.Metadata.Header.UrlKey));
header.SetFieldValue(Models.Metadata.Header.VersionKey,
GetStringFieldValue(Models.Metadata.Header.VersionKey));
return header;
}
///
/// Clone the filtering parts of the current header
///
public DatHeader CloneFiltering()
{
var header = new DatHeader();
header.SetFieldValue(DatHeader.AddExtensionKey,
GetStringFieldValue(DatHeader.AddExtensionKey));
header.SetFieldValue(DatHeader.DatFormatKey,
GetFieldValue(DatHeader.DatFormatKey));
header.SetFieldValue(DatHeader.GameNameKey,
GetBoolFieldValue(DatHeader.GameNameKey));
header.SetFieldValue(DatHeader.InputDepotKey,
GetFieldValue(DatHeader.InputDepotKey)?.Clone() as DepotInformation);
header.SetFieldValue(DatHeader.OutputDepotKey,
GetFieldValue(DatHeader.OutputDepotKey)?.Clone() as DepotInformation);
header.SetFieldValue(DatHeader.PostfixKey,
GetStringFieldValue(DatHeader.PostfixKey));
header.SetFieldValue(DatHeader.PrefixKey,
GetStringFieldValue(DatHeader.PrefixKey));
header.SetFieldValue(DatHeader.RemoveExtensionKey,
GetBoolFieldValue(DatHeader.RemoveExtensionKey));
header.SetFieldValue(DatHeader.ReplaceExtensionKey,
GetStringFieldValue(DatHeader.ReplaceExtensionKey));
header.SetFieldValue(DatHeader.QuotesKey,
GetBoolFieldValue(DatHeader.QuotesKey));
header.SetFieldValue(DatHeader.UseRomNameKey,
GetBoolFieldValue(DatHeader.UseRomNameKey));
return header;
}
///
/// Get a clone of the current internal model
///
public Models.Metadata.Header GetInternalClone()
{
var header = (_internal.Clone() as Models.Metadata.Header)!;
// Remove fields with default values
if (header.ReadString(Models.Metadata.Header.ForceMergingKey).AsEnumValue() == MergingFlag.None)
header.Remove(Models.Metadata.Header.ForceMergingKey);
if (header.ReadString(Models.Metadata.Header.ForceNodumpKey).AsEnumValue() == NodumpFlag.None)
header.Remove(Models.Metadata.Header.ForceNodumpKey);
if (header.ReadString(Models.Metadata.Header.ForcePackingKey).AsEnumValue() == PackingFlag.None)
header.Remove(Models.Metadata.Header.ForcePackingKey);
// Convert subheader values
if (CanOpenSpecified)
header[Models.Metadata.Header.CanOpenKey] = new Models.OfflineList.CanOpen { Extension = GetStringArrayFieldValue(Models.Metadata.Header.CanOpenKey) };
if (ImagesSpecified)
header[Models.Metadata.Header.ImagesKey] = GetFieldValue(Models.Metadata.Header.ImagesKey);
if (InfosSpecified)
header[Models.Metadata.Header.InfosKey] = GetFieldValue(Models.Metadata.Header.InfosKey);
if (NewDatSpecified)
header[Models.Metadata.Header.NewDatKey] = GetFieldValue(Models.Metadata.Header.NewDatKey);
if (SearchSpecified)
header[Models.Metadata.Header.SearchKey] = GetFieldValue(Models.Metadata.Header.SearchKey);
return header;
}
///
/// Overwrite local values from another DatHeader if not default
///
/// DatHeader to get the values from
public void ConditionalCopy(DatHeader? datHeader)
{
if (datHeader == null)
return;
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(DatHeader.FileNameKey)))
SetFieldValue(DatHeader.FileNameKey,
datHeader.GetStringFieldValue(DatHeader.FileNameKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.NameKey)))
SetFieldValue(Models.Metadata.Header.NameKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.NameKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.DescriptionKey)))
SetFieldValue(Models.Metadata.Header.DescriptionKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.DescriptionKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.RootDirKey)))
SetFieldValue(Models.Metadata.Header.RootDirKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.RootDirKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.CategoryKey)))
SetFieldValue(Models.Metadata.Header.CategoryKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.CategoryKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.VersionKey)))
SetFieldValue(Models.Metadata.Header.VersionKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.VersionKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.DateKey)))
SetFieldValue(Models.Metadata.Header.DateKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.DateKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.AuthorKey)))
SetFieldValue(Models.Metadata.Header.AuthorKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.AuthorKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.EmailKey)))
SetFieldValue(Models.Metadata.Header.EmailKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.EmailKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.HomepageKey)))
SetFieldValue(Models.Metadata.Header.HomepageKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.HomepageKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.UrlKey)))
SetFieldValue(Models.Metadata.Header.UrlKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.UrlKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.CommentKey)))
SetFieldValue(Models.Metadata.Header.CommentKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.CommentKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.HeaderKey)))
SetFieldValue(Models.Metadata.Header.HeaderKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.HeaderKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(Models.Metadata.Header.TypeKey)))
SetFieldValue(Models.Metadata.Header.TypeKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.TypeKey));
if (datHeader.GetStringFieldValue(Models.Metadata.Header.ForceMergingKey).AsEnumValue() != MergingFlag.None)
SetFieldValue(Models.Metadata.Header.ForceMergingKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.ForceMergingKey).AsEnumValue().AsStringValue());
if (datHeader.GetStringFieldValue(Models.Metadata.Header.ForceNodumpKey).AsEnumValue() != NodumpFlag.None)
SetFieldValue(Models.Metadata.Header.ForceNodumpKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.ForceNodumpKey).AsEnumValue().AsStringValue());
if (datHeader.GetStringFieldValue(Models.Metadata.Header.ForcePackingKey).AsEnumValue() != PackingFlag.None)
SetFieldValue(Models.Metadata.Header.ForcePackingKey,
datHeader.GetStringFieldValue(Models.Metadata.Header.ForcePackingKey).AsEnumValue().AsStringValue());
if (datHeader.GetFieldValue(DatHeader.DatFormatKey) != 0x00)
SetFieldValue(DatHeader.DatFormatKey,
datHeader.GetFieldValue(DatHeader.DatFormatKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(DatHeader.PrefixKey)))
SetFieldValue(DatHeader.PrefixKey,
datHeader.GetStringFieldValue(DatHeader.PrefixKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(DatHeader.PostfixKey)))
SetFieldValue(DatHeader.PostfixKey,
datHeader.GetStringFieldValue(DatHeader.PostfixKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(DatHeader.AddExtensionKey)))
SetFieldValue(DatHeader.AddExtensionKey,
datHeader.GetStringFieldValue(DatHeader.AddExtensionKey));
if (!string.IsNullOrEmpty(datHeader.GetStringFieldValue(DatHeader.ReplaceExtensionKey)))
SetFieldValue(DatHeader.ReplaceExtensionKey,
datHeader.GetStringFieldValue(DatHeader.ReplaceExtensionKey));
SetFieldValue(DatHeader.InputDepotKey,
datHeader.GetFieldValue(DatHeader.InputDepotKey)?.Clone() as DepotInformation);
SetFieldValue(DatHeader.OutputDepotKey,
datHeader.GetFieldValue(DatHeader.OutputDepotKey)?.Clone() as DepotInformation);
SetFieldValue(DatHeader.GameNameKey,
datHeader.GetBoolFieldValue(DatHeader.GameNameKey));
SetFieldValue(DatHeader.QuotesKey,
datHeader.GetBoolFieldValue(DatHeader.QuotesKey));
SetFieldValue(DatHeader.RemoveExtensionKey,
datHeader.GetBoolFieldValue(DatHeader.RemoveExtensionKey));
SetFieldValue(DatHeader.UseRomNameKey,
datHeader.GetBoolFieldValue(DatHeader.UseRomNameKey));
}
#endregion
#region Comparision Methods
///
public override bool Equals(ModelBackedItem? other)
{
// If other is null
if (other == null)
return false;
// If the type is mismatched
if (other is not DatHeader otherItem)
return false;
// Compare internal models
return _internal.EqualTo(otherItem._internal);
}
///
public override bool Equals(ModelBackedItem? other)
{
// If other is null
if (other == null)
return false;
// If the type is mismatched
if (other is not DatHeader otherItem)
return false;
// Compare internal models
return _internal.EqualTo(otherItem._internal);
}
#endregion
#region Manipulation
///
/// Runs a filter and determines if it passes or not
///
/// Filter runner to use for checking
/// True if the Machine passes the filter, false otherwise
public bool PassesFilter(FilterRunner filterRunner) => filterRunner.Run(_internal);
#endregion
}
}