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

Add verbose logging to ShouldIgnore; add note

Browse Source
This commit is contained in:
Matt Nadareski
2022-11-03 16:27:58 -07:00
parent 4ea8abc1a4
commit b3b2176b01
1 changed files with 21 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
SabreTools.DatFiles/DatFile.cs
View File

@@ -513,6 +513,7 @@ namespace SabreTools.DatFiles
/// <returns>True if the item has all required fields, false otherwise</returns> /// <returns>True if the item has all required fields, false otherwise</returns>
/// <remarks> /// <remarks>
/// TODO: Implement this in all relevant DatFile types /// TODO: Implement this in all relevant DatFile types
/// TODO: Return list of missing fields?
/// </remarks> /// </remarks>
protected virtual bool HasRequiredFields(DatItem datItem) => true; protected virtual bool HasRequiredFields(DatItem datItem) => true;
@@ -545,15 +546,21 @@ namespace SabreTools.DatFiles
/// <returns>True if the item should be skipped on write, false otherwise</returns> /// <returns>True if the item should be skipped on write, false otherwise</returns>
protected bool ShouldIgnore(DatItem datItem, bool ignoreBlanks) protected bool ShouldIgnore(DatItem datItem, bool ignoreBlanks)
{ {
// TODO: Add non-error, non-warning logging to this method to capture ignore reasons
// If the item is supposed to be removed, we ignore // If the item is supposed to be removed, we ignore
if (datItem.Remove) if (datItem.Remove)
{
string itemString = JsonConvert.SerializeObject(datItem, Formatting.None);
logger?.Verbose($"Item '{itemString}' was skipped because it was marked for removal");
return true; return true;
}
// If we have the Blank dat item, we ignore // If we have the Blank dat item, we ignore
if (datItem.ItemType == ItemType.Blank) if (datItem.ItemType == ItemType.Blank)
{
string itemString = JsonConvert.SerializeObject(datItem, Formatting.None);
logger?.Verbose($"Item '{itemString}' was skipped because it was of type 'Blank'");
return true; return true;
}
// If we're ignoring blanks and we have a Rom // If we're ignoring blanks and we have a Rom
if (ignoreBlanks && datItem.ItemType == ItemType.Rom) if (ignoreBlanks && datItem.ItemType == ItemType.Rom)
@@ -562,16 +569,28 @@ namespace SabreTools.DatFiles
// If we have a 0-size or blank rom, then we ignore // If we have a 0-size or blank rom, then we ignore
if (rom.Size == 0 || rom.Size == null) if (rom.Size == 0 || rom.Size == null)
{
string itemString = JsonConvert.SerializeObject(datItem, Formatting.None);
logger?.Verbose($"Item '{itemString}' was skipped because it had an invalid size");
return true; return true;
}
} }
// If we have an item type not in the list of supported values // If we have an item type not in the list of supported values
if (!GetSupportedTypes().Contains(datItem.ItemType)) if (!GetSupportedTypes().Contains(datItem.ItemType))
{
string itemString = JsonConvert.SerializeObject(datItem, Formatting.None);
logger?.Verbose($"Item '{itemString}' was skipped because it was not supported in {Header?.DatFormat}");
return true; return true;
}
// If we have an item with missing required fields // If we have an item with missing required fields
if (!HasRequiredFields(datItem)) if (!HasRequiredFields(datItem))
{
string itemString = JsonConvert.SerializeObject(datItem, Formatting.None);
logger?.Verbose($"Item '{itemString}' was skipped because it was missing required fields for {Header?.DatFormat}");
return true; return true;
}
return false; return false;
} }