mirror of
https://github.com/claunia/SabreTools.git
synced 2025-12-16 19:14:27 +00:00
Create and use DosCenter serializer
This commit is contained in:
Matt Nadareski
163
SabreTools.DatFiles/Formats/DosCenter.Reader.cs
Normal file
163
SabreTools.DatFiles/Formats/DosCenter.Reader.cs
Normal file
@@ -0,0 +1,163 @@
|
||||
using System;
|
||||
using System.Linq;
|
||||
using SabreTools.Core.Tools;
|
||||
using SabreTools.DatItems;
|
||||
using SabreTools.DatItems.Formats;
|
||||
|
||||
namespace SabreTools.DatFiles.Formats
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents parsing and writing of a DosCenter DAT
|
||||
/// </summary>
|
||||
internal partial class DosCenter : DatFile
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
public override void ParseFile(string filename, int indexId, bool keep, bool statsOnly = false, bool throwOnError = false)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Deserialize the input file
|
||||
var metadataFile = Serialization.DosCenter.Deserialize(filename);
|
||||
|
||||
// Convert the header to the internal format
|
||||
ConvertHeader(metadataFile?.DosCenter, keep);
|
||||
|
||||
// Convert the game data to the internal format
|
||||
ConvertGames(metadataFile?.Game, filename, indexId, statsOnly);
|
||||
}
|
||||
catch (Exception ex) when (!throwOnError)
|
||||
{
|
||||
string message = $"'{filename}' - An error occurred during parsing";
|
||||
logger.Error(ex, message);
|
||||
}
|
||||
}
|
||||
|
||||
#region Converters
|
||||
|
||||
/// <summary>
|
||||
/// Convert header information
|
||||
/// </summary>
|
||||
/// <param name="doscenter">Deserialized model to convert</param>
|
||||
/// <param name="keep">True if full pathnames are to be kept, false otherwise (default)</param>
|
||||
private void ConvertHeader(Models.DosCenter.DosCenter? doscenter, bool keep)
|
||||
{
|
||||
// If the header is missing, we can't do anything
|
||||
if (doscenter == null)
|
||||
return;
|
||||
|
||||
Header.Name ??= doscenter.Name;
|
||||
Header.Description ??= doscenter.Description;
|
||||
Header.Version ??= doscenter.Version;
|
||||
Header.Date ??= doscenter.Date;
|
||||
Header.Author ??= doscenter.Author;
|
||||
Header.Homepage ??= doscenter.Homepage;
|
||||
Header.Comment ??= doscenter.Comment;
|
||||
|
||||
// Handle implied SuperDAT
|
||||
if (doscenter.Name.Contains(" - SuperDAT") && keep)
|
||||
Header.Type ??= "SuperDAT";
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Convert games information
|
||||
/// </summary>
|
||||
/// <param name="games">Array of deserialized models to convert</param>
|
||||
/// <param name="filename">Name of the file to be parsed</param>
|
||||
/// <param name="indexId">Index ID for the DAT</param>
|
||||
/// <param name="statsOnly">True to only add item statistics while parsing, false otherwise</param>
|
||||
private void ConvertGames(Models.DosCenter.Game[]? games, string filename, int indexId, bool statsOnly)
|
||||
{
|
||||
// If the game array is missing, we can't do anything
|
||||
if (games == null || !games.Any())
|
||||
return;
|
||||
|
||||
// Loop through the games and add
|
||||
foreach (var game in games)
|
||||
{
|
||||
ConvertGame(game, filename, indexId, statsOnly);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Convert game information
|
||||
/// </summary>
|
||||
/// <param name="game">Deserialized model to convert</param>
|
||||
/// <param name="filename">Name of the file to be parsed</param>
|
||||
/// <param name="indexId">Index ID for the DAT</param>
|
||||
/// <param name="statsOnly">True to only add item statistics while parsing, false otherwise</param>
|
||||
private void ConvertGame(Models.DosCenter.Game game, string filename, int indexId, bool statsOnly)
|
||||
{
|
||||
// If the game is missing, we can't do anything
|
||||
if (game == null)
|
||||
return;
|
||||
|
||||
// Create the machine for copying information
|
||||
string machineName = game.Name.Trim('"');
|
||||
if (machineName.EndsWith(".zip"))
|
||||
machineName = System.IO.Path.GetFileNameWithoutExtension(machineName);
|
||||
|
||||
var machine = new Machine { Name = machineName };
|
||||
|
||||
// Check if there are any items
|
||||
bool containsItems = false;
|
||||
|
||||
// Loop through each type of item
|
||||
ConvertFiles(game.File, machine, filename, indexId, statsOnly, ref containsItems);
|
||||
|
||||
// If we had no items, create a Blank placeholder
|
||||
if (!containsItems)
|
||||
{
|
||||
var blank = new Blank
|
||||
{
|
||||
Source = new Source
|
||||
{
|
||||
Index = indexId,
|
||||
Name = filename,
|
||||
},
|
||||
};
|
||||
|
||||
blank.CopyMachineInformation(machine);
|
||||
ParseAddHelper(blank, statsOnly);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Convert Rom information
|
||||
/// </summary>
|
||||
/// <param name="files">Array of deserialized models to convert</param>
|
||||
/// <param name="machine">Prefilled machine to use</param>
|
||||
/// <param name="filename">Name of the file to be parsed</param>
|
||||
/// <param name="indexId">Index ID for the DAT</param>
|
||||
/// <param name="statsOnly">True to only add item statistics while parsing, false otherwise</param>
|
||||
/// <param name="containsItems">True if there were any items in the array, false otherwise</param>
|
||||
private void ConvertFiles(Models.DosCenter.File[]? files, Machine machine, string filename, int indexId, bool statsOnly, ref bool containsItems)
|
||||
{
|
||||
// If the files array is missing, we can't do anything
|
||||
if (files == null || !files.Any())
|
||||
return;
|
||||
|
||||
containsItems = true;
|
||||
foreach (var rom in files)
|
||||
{
|
||||
var item = new Rom
|
||||
{
|
||||
Name = rom.Name,
|
||||
Size = Utilities.CleanLong(rom.Size),
|
||||
CRC = rom.CRC,
|
||||
Date = rom.Date,
|
||||
|
||||
Source = new Source
|
||||
{
|
||||
Index = indexId,
|
||||
Name = filename,
|
||||
},
|
||||
};
|
||||
|
||||
item.CopyMachineInformation(machine);
|
||||
ParseAddHelper(item, statsOnly);
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
184
SabreTools.DatFiles/Formats/DosCenter.Writer.cs
Normal file
184
SabreTools.DatFiles/Formats/DosCenter.Writer.cs
Normal file
@@ -0,0 +1,184 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using SabreTools.Core;
|
||||
using SabreTools.DatItems;
|
||||
using SabreTools.DatItems.Formats;
|
||||
|
||||
namespace SabreTools.DatFiles.Formats
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents parsing and writing of a DosCenter DAT
|
||||
/// </summary>
|
||||
internal partial class DosCenter : DatFile
|
||||
{
|
||||
/// <inheritdoc/>
|
||||
protected override ItemType[] GetSupportedTypes()
|
||||
{
|
||||
return new ItemType[]
|
||||
{
|
||||
ItemType.Rom
|
||||
};
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
protected override List<DatItemField> GetMissingRequiredFields(DatItem datItem)
|
||||
{
|
||||
List<DatItemField> missingFields = new();
|
||||
|
||||
// Check item name
|
||||
if (string.IsNullOrWhiteSpace(datItem.GetName()))
|
||||
missingFields.Add(DatItemField.Name);
|
||||
|
||||
switch (datItem)
|
||||
{
|
||||
case Rom rom:
|
||||
if (!rom.SizeSpecified)
|
||||
missingFields.Add(DatItemField.Size);
|
||||
// if (string.IsNullOrWhiteSpace(rom.Date))
|
||||
// missingFields.Add(DatItemField.Date);
|
||||
if (string.IsNullOrWhiteSpace(rom.CRC))
|
||||
missingFields.Add(DatItemField.CRC);
|
||||
break;
|
||||
}
|
||||
|
||||
return missingFields;
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override bool WriteToFile(string outfile, bool ignoreblanks = false, bool throwOnError = false)
|
||||
{
|
||||
try
|
||||
{
|
||||
logger.User($"Writing to '{outfile}'...");
|
||||
|
||||
var metadataFile = CreateMetadataFile(ignoreblanks);
|
||||
if (!Serialization.DosCenter.SerializeToFile(metadataFile, outfile))
|
||||
{
|
||||
logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
catch (Exception ex) when (!throwOnError)
|
||||
{
|
||||
logger.Error(ex);
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
#region Converters
|
||||
|
||||
/// <summary>
|
||||
/// Create a MetadataFile from the current internal information
|
||||
/// <summary>
|
||||
/// <param name="ignoreblanks">True if blank roms should be skipped on output, false otherwise</param>
|
||||
private Models.DosCenter.MetadataFile CreateMetadataFile(bool ignoreblanks)
|
||||
{
|
||||
var metadataFile = new Models.DosCenter.MetadataFile
|
||||
{
|
||||
DosCenter = CreateDosCenter(),
|
||||
Game = CreateGames(ignoreblanks)
|
||||
};
|
||||
return metadataFile;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Create a DosCenter from the current internal information
|
||||
/// <summary>
|
||||
private Models.DosCenter.DosCenter? CreateDosCenter()
|
||||
{
|
||||
// If we don't have a header, we can't do anything
|
||||
if (this.Header == null)
|
||||
return null;
|
||||
|
||||
var clrMamePro = new Models.DosCenter.DosCenter
|
||||
{
|
||||
Name = Header.Name,
|
||||
Description = Header.Description,
|
||||
Version = Header.Version,
|
||||
Date = Header.Date,
|
||||
Author = Header.Author,
|
||||
Homepage = Header.Homepage,
|
||||
Comment = Header.Comment,
|
||||
};
|
||||
|
||||
return clrMamePro;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Create an array of GameBase from the current internal information
|
||||
/// <summary>
|
||||
/// <param name="ignoreblanks">True if blank roms should be skipped on output, false otherwise</param>
|
||||
private Models.DosCenter.Game[]? CreateGames(bool ignoreblanks)
|
||||
{
|
||||
// If we don't have items, we can't do anything
|
||||
if (this.Items == null || !this.Items.Any())
|
||||
return null;
|
||||
|
||||
// Create a list of hold the games
|
||||
var games = new List<Models.DosCenter.Game>();
|
||||
|
||||
// Loop through the sorted items and create games for them
|
||||
foreach (string key in Items.SortedKeys)
|
||||
{
|
||||
var items = Items.FilteredItems(key);
|
||||
if (items == null || !items.Any())
|
||||
continue;
|
||||
|
||||
// Get the first item for game information
|
||||
var machine = items[0].Machine;
|
||||
|
||||
// We re-add the missing parts of the game name
|
||||
var game = new Models.DosCenter.Game
|
||||
{
|
||||
Name = $"\"{machine.Name}.zip\""
|
||||
};
|
||||
|
||||
// Create holders for all item types
|
||||
var files = new List<Models.DosCenter.File>();
|
||||
|
||||
// Loop through and convert the items to respective lists
|
||||
foreach (var item in items)
|
||||
{
|
||||
// Skip if we're ignoring the item
|
||||
if (ShouldIgnore(item, ignoreblanks))
|
||||
continue;
|
||||
|
||||
switch (item)
|
||||
{
|
||||
case Rom rom:
|
||||
files.Add(CreateFile(rom));
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Assign the values to the game
|
||||
game.File = files.ToArray();
|
||||
|
||||
// Add the game to the list
|
||||
games.Add(game);
|
||||
}
|
||||
|
||||
return games.ToArray();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Create a File from the current Rom DatItem
|
||||
/// <summary>
|
||||
private static Models.DosCenter.File CreateFile(Rom item)
|
||||
{
|
||||
var rom = new Models.DosCenter.File
|
||||
{
|
||||
Name = item.Name,
|
||||
Size = item.Size?.ToString(),
|
||||
CRC = item.CRC,
|
||||
Date = item.Date,
|
||||
};
|
||||
return rom;
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
@@ -1,22 +1,9 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
using SabreTools.Core;
|
||||
using SabreTools.Core.Tools;
|
||||
using SabreTools.DatItems;
|
||||
using SabreTools.DatItems.Formats;
|
||||
using SabreTools.IO;
|
||||
using SabreTools.IO.Readers;
|
||||
using SabreTools.IO.Writers;
|
||||
|
||||
namespace SabreTools.DatFiles.Formats
|
||||
namespace SabreTools.DatFiles.Formats
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents parsing and writing of a DosCenter DAT
|
||||
/// Represents a DosCenter DAT
|
||||
/// </summary>
|
||||
internal class DosCenter : DatFile
|
||||
internal partial class DosCenter : DatFile
|
||||
{
|
||||
/// <summary>
|
||||
/// Constructor designed for casting a base DatFile
|
||||
@@ -26,414 +13,5 @@ namespace SabreTools.DatFiles.Formats
|
||||
: base(datFile)
|
||||
{
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override void ParseFile(string filename, int indexId, bool keep, bool statsOnly = false, bool throwOnError = false)
|
||||
{
|
||||
// Open a file reader
|
||||
Encoding enc = filename.GetEncoding();
|
||||
ClrMameProReader cmpr = new(System.IO.File.OpenRead(filename), enc)
|
||||
{
|
||||
DosCenter = true
|
||||
};
|
||||
|
||||
while (!cmpr.EndOfStream)
|
||||
{
|
||||
try
|
||||
{
|
||||
cmpr.ReadNextLine();
|
||||
|
||||
// Ignore everything not top-level
|
||||
if (cmpr.RowType != CmpRowType.TopLevel)
|
||||
continue;
|
||||
|
||||
// Switch on the top-level name
|
||||
switch (cmpr.TopLevel.ToLowerInvariant())
|
||||
{
|
||||
// Header values
|
||||
case "doscenter":
|
||||
ReadHeader(cmpr);
|
||||
break;
|
||||
|
||||
// Sets
|
||||
case "game":
|
||||
ReadGame(cmpr, statsOnly, filename, indexId);
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
catch (Exception ex) when (!throwOnError)
|
||||
{
|
||||
string message = $"'{filename}' - There was an error parsing line {cmpr.LineNumber} '{cmpr.CurrentLine}'";
|
||||
logger.Error(ex, message);
|
||||
}
|
||||
}
|
||||
|
||||
cmpr.Dispose();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read header information
|
||||
/// </summary>
|
||||
/// <param name="cmpr">ClrMameProReader to use to parse the header</param>
|
||||
private void ReadHeader(ClrMameProReader cmpr)
|
||||
{
|
||||
// If there's no subtree to the header, skip it
|
||||
if (cmpr == null || cmpr.EndOfStream)
|
||||
return;
|
||||
|
||||
// While we don't hit an end element or end of stream
|
||||
while (!cmpr.EndOfStream)
|
||||
{
|
||||
cmpr.ReadNextLine();
|
||||
|
||||
// Ignore comments, internal items, and nothingness
|
||||
if (cmpr.RowType == CmpRowType.None || cmpr.RowType == CmpRowType.Comment || cmpr.RowType == CmpRowType.Internal)
|
||||
continue;
|
||||
|
||||
// If we reached the end of a section, break
|
||||
if (cmpr.RowType == CmpRowType.EndTopLevel)
|
||||
break;
|
||||
|
||||
// If the standalone value is null, we skip
|
||||
if (cmpr.Standalone == null)
|
||||
continue;
|
||||
|
||||
string itemKey = cmpr.Standalone?.Key.ToLowerInvariant().TrimEnd(':');
|
||||
string itemVal = cmpr.Standalone?.Value;
|
||||
|
||||
// For all other cases
|
||||
switch (itemKey)
|
||||
{
|
||||
case "name":
|
||||
Header.Name ??= itemVal;
|
||||
break;
|
||||
case "description":
|
||||
Header.Description ??= itemVal;
|
||||
break;
|
||||
case "version":
|
||||
Header.Version ??= itemVal;
|
||||
break;
|
||||
case "date":
|
||||
Header.Date ??= itemVal;
|
||||
break;
|
||||
case "author":
|
||||
Header.Author ??= itemVal;
|
||||
break;
|
||||
case "homepage":
|
||||
Header.Homepage ??= itemVal;
|
||||
break;
|
||||
case "comment":
|
||||
Header.Comment ??= itemVal;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read set information
|
||||
/// </summary>
|
||||
/// <param name="cmpr">ClrMameProReader to use to parse the header</param>
|
||||
/// <param name="statsOnly">True to only add item statistics while parsing, false otherwise</param>
|
||||
/// <param name="filename">Name of the file to be parsed</param>
|
||||
/// <param name="indexId">Index ID for the DAT</param>
|
||||
private void ReadGame(ClrMameProReader cmpr, bool statsOnly, string filename, int indexId)
|
||||
{
|
||||
// Prepare all internal variables
|
||||
bool containsItems = false;
|
||||
Machine machine = new()
|
||||
{
|
||||
MachineType = MachineType.None,
|
||||
};
|
||||
|
||||
// If there's no subtree to the header, skip it
|
||||
if (cmpr == null || cmpr.EndOfStream)
|
||||
return;
|
||||
|
||||
// While we don't hit an end element or end of stream
|
||||
while (!cmpr.EndOfStream)
|
||||
{
|
||||
cmpr.ReadNextLine();
|
||||
|
||||
// Ignore comments and nothingness
|
||||
if (cmpr.RowType == CmpRowType.None || cmpr.RowType == CmpRowType.Comment)
|
||||
continue;
|
||||
|
||||
// If we reached the end of a section, break
|
||||
if (cmpr.RowType == CmpRowType.EndTopLevel)
|
||||
break;
|
||||
|
||||
// Handle any standalone items
|
||||
if (cmpr.RowType == CmpRowType.Standalone && cmpr.Standalone != null)
|
||||
{
|
||||
string itemKey = cmpr.Standalone?.Key.ToLowerInvariant();
|
||||
string itemVal = cmpr.Standalone?.Value;
|
||||
|
||||
switch (itemKey)
|
||||
{
|
||||
case "name":
|
||||
machine.Name = (itemVal.ToLowerInvariant().EndsWith(".zip") ? itemVal.Remove(itemVal.Length - 4) : itemVal);
|
||||
machine.Description = (itemVal.ToLowerInvariant().EndsWith(".zip") ? itemVal.Remove(itemVal.Length - 4) : itemVal);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Handle any internal items
|
||||
else if (cmpr.RowType == CmpRowType.Internal
|
||||
&& string.Equals(cmpr.InternalName, "file", StringComparison.OrdinalIgnoreCase)
|
||||
&& cmpr.Internal != null)
|
||||
{
|
||||
containsItems = true;
|
||||
|
||||
// Create the proper DatItem based on the type
|
||||
Rom item = DatItem.Create(ItemType.Rom) as Rom;
|
||||
|
||||
// Then populate it with information
|
||||
item.CopyMachineInformation(machine);
|
||||
item.Source = new Source
|
||||
{
|
||||
Index = indexId,
|
||||
Name = filename,
|
||||
};
|
||||
|
||||
// Loop through all of the attributes
|
||||
foreach (var kvp in cmpr.Internal)
|
||||
{
|
||||
string attrKey = kvp.Key;
|
||||
string attrVal = kvp.Value;
|
||||
|
||||
switch (attrKey)
|
||||
{
|
||||
//If the item is empty, we automatically skip it because it's a fluke
|
||||
case "":
|
||||
continue;
|
||||
|
||||
// Regular attributes
|
||||
case "name":
|
||||
item.Name = attrVal;
|
||||
break;
|
||||
|
||||
case "size":
|
||||
item.Size = Utilities.CleanLong(attrVal);
|
||||
break;
|
||||
|
||||
case "crc":
|
||||
item.CRC = attrVal;
|
||||
break;
|
||||
case "date":
|
||||
item.Date = attrVal;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Now process and add the rom
|
||||
ParseAddHelper(item, statsOnly);
|
||||
}
|
||||
}
|
||||
|
||||
// If no items were found for this machine, add a Blank placeholder
|
||||
if (!containsItems)
|
||||
{
|
||||
Blank blank = new()
|
||||
{
|
||||
Source = new Source
|
||||
{
|
||||
Index = indexId,
|
||||
Name = filename,
|
||||
},
|
||||
};
|
||||
|
||||
blank.CopyMachineInformation(machine);
|
||||
|
||||
// Now process and add the rom
|
||||
ParseAddHelper(blank, statsOnly);
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
protected override ItemType[] GetSupportedTypes()
|
||||
{
|
||||
return new ItemType[] { ItemType.Rom };
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
protected override List<DatItemField> GetMissingRequiredFields(DatItem datItem)
|
||||
{
|
||||
// TODO: Check required fields
|
||||
return null;
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override bool WriteToFile(string outfile, bool ignoreblanks = false, bool throwOnError = false)
|
||||
{
|
||||
try
|
||||
{
|
||||
logger.User($"Writing to '{outfile}'...");
|
||||
FileStream fs = System.IO.File.Create(outfile);
|
||||
|
||||
// If we get back null for some reason, just log and return
|
||||
if (fs == null)
|
||||
{
|
||||
logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable");
|
||||
return false;
|
||||
}
|
||||
|
||||
ClrMameProWriter cmpw = new(fs, new UTF8Encoding(false))
|
||||
{
|
||||
Quotes = false
|
||||
};
|
||||
|
||||
// Write out the header
|
||||
WriteHeader(cmpw);
|
||||
|
||||
// Write out each of the machines and roms
|
||||
string lastgame = null;
|
||||
|
||||
// Use a sorted list of games to output
|
||||
foreach (string key in Items.SortedKeys)
|
||||
{
|
||||
ConcurrentList<DatItem> datItems = Items.FilteredItems(key);
|
||||
|
||||
// If this machine doesn't contain any writable items, skip
|
||||
if (!ContainsWritable(datItems))
|
||||
continue;
|
||||
|
||||
// Resolve the names in the block
|
||||
datItems = DatItem.ResolveNames(datItems);
|
||||
|
||||
for (int index = 0; index < datItems.Count; index++)
|
||||
{
|
||||
DatItem datItem = datItems[index];
|
||||
|
||||
List<string> newsplit = datItem.Machine.Name.Split('\\').ToList();
|
||||
|
||||
// If we have a different game and we're not at the start of the list, output the end of last item
|
||||
if (lastgame != null && lastgame.ToLowerInvariant() != datItem.Machine.Name.ToLowerInvariant())
|
||||
WriteEndGame(cmpw);
|
||||
|
||||
// If we have a new game, output the beginning of the new item
|
||||
if (lastgame == null || lastgame.ToLowerInvariant() != datItem.Machine.Name.ToLowerInvariant())
|
||||
WriteStartGame(cmpw, datItem);
|
||||
|
||||
// Check for a "null" item
|
||||
datItem = ProcessNullifiedItem(datItem);
|
||||
|
||||
// Write out the item if we're not ignoring
|
||||
if (!ShouldIgnore(datItem, ignoreblanks))
|
||||
WriteDatItem(cmpw, datItem);
|
||||
|
||||
// Set the new data to compare against
|
||||
lastgame = datItem.Machine.Name;
|
||||
}
|
||||
}
|
||||
|
||||
// Write the file footer out
|
||||
WriteFooter(cmpw);
|
||||
|
||||
logger.User($"'{outfile}' written!{Environment.NewLine}");
|
||||
cmpw.Dispose();
|
||||
fs.Dispose();
|
||||
}
|
||||
catch (Exception ex) when (!throwOnError)
|
||||
{
|
||||
logger.Error(ex);
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write out DAT header using the supplied StreamWriter
|
||||
/// </summary>
|
||||
/// <param name="cmpw">ClrMameProWriter to output to</param>
|
||||
private void WriteHeader(ClrMameProWriter cmpw)
|
||||
{
|
||||
// Build the state
|
||||
cmpw.WriteStartElement("DOSCenter");
|
||||
|
||||
cmpw.WriteRequiredStandalone("Name:", Header.Name, false);
|
||||
cmpw.WriteRequiredStandalone("Description:", Header.Description, false);
|
||||
cmpw.WriteRequiredStandalone("Version:", Header.Version, false);
|
||||
cmpw.WriteRequiredStandalone("Date:", Header.Date, false);
|
||||
cmpw.WriteRequiredStandalone("Author:", Header.Author, false);
|
||||
cmpw.WriteRequiredStandalone("Homepage:", Header.Homepage, false);
|
||||
cmpw.WriteRequiredStandalone("Comment:", Header.Comment, false);
|
||||
|
||||
cmpw.WriteEndElement();
|
||||
|
||||
cmpw.Flush();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write out Game start using the supplied StreamWriter
|
||||
/// </summary>
|
||||
/// <param name="cmpw">ClrMameProWriter to output to</param>
|
||||
/// <param name="datItem">DatItem object to be output</param>
|
||||
private void WriteStartGame(ClrMameProWriter cmpw, DatItem datItem)
|
||||
{
|
||||
// No game should start with a path separator
|
||||
datItem.Machine.Name = datItem.Machine.Name.TrimStart(Path.DirectorySeparatorChar);
|
||||
|
||||
// Build the state
|
||||
cmpw.WriteStartElement("game");
|
||||
cmpw.WriteRequiredStandalone("name", $"{datItem.Machine.Name}.zip", true);
|
||||
|
||||
cmpw.Flush();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write out Game end using the supplied StreamWriter
|
||||
/// </summary>
|
||||
/// <param name="cmpw">ClrMameProWriter to output to</param>
|
||||
private void WriteEndGame(ClrMameProWriter cmpw)
|
||||
{
|
||||
// End game
|
||||
cmpw.WriteEndElement();
|
||||
|
||||
cmpw.Flush();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write out DatItem using the supplied StreamWriter
|
||||
/// </summary>
|
||||
/// <param name="cmpw">ClrMameProWriter to output to</param>
|
||||
/// <param name="datItem">DatItem object to be output</param>
|
||||
private void WriteDatItem(ClrMameProWriter cmpw, DatItem datItem)
|
||||
{
|
||||
// Pre-process the item name
|
||||
ProcessItemName(datItem, true);
|
||||
|
||||
// Build the state
|
||||
switch (datItem.ItemType)
|
||||
{
|
||||
case ItemType.Rom:
|
||||
var rom = datItem as Rom;
|
||||
cmpw.WriteStartElement("file");
|
||||
cmpw.WriteRequiredAttributeString("name", rom.Name);
|
||||
cmpw.WriteOptionalAttributeString("size", rom.Size?.ToString());
|
||||
cmpw.WriteOptionalAttributeString("date", rom.Date);
|
||||
cmpw.WriteOptionalAttributeString("crc", rom.CRC?.ToLowerInvariant());
|
||||
cmpw.WriteEndElement();
|
||||
break;
|
||||
}
|
||||
|
||||
cmpw.Flush();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write out DAT footer using the supplied StreamWriter
|
||||
/// </summary>
|
||||
/// <param name="cmpw">ClrMameProWriter to output to</param>
|
||||
/// <returns>True if the data was written, false on error</returns>
|
||||
private void WriteFooter(ClrMameProWriter cmpw)
|
||||
{
|
||||
// End game
|
||||
cmpw.WriteEndElement();
|
||||
|
||||
cmpw.Flush();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,16 +4,16 @@ namespace SabreTools.Models.DosCenter
|
||||
public class File
|
||||
{
|
||||
/// <remarks>name, attribute</remarks>
|
||||
public string? Name { get; set; }
|
||||
public string Name { get; set; }
|
||||
|
||||
/// <remarks>size, attribute, numeric</remarks>
|
||||
public string? Size { get; set; }
|
||||
public string Size { get; set; }
|
||||
|
||||
/// <remarks>crc, attribute</remarks>
|
||||
public string? CRC { get; set; }
|
||||
public string CRC { get; set; }
|
||||
|
||||
/// <remarks>date, attribute</remarks>
|
||||
public string? Date { get; set; }
|
||||
public string Date { get; set; }
|
||||
|
||||
#region DO NOT USE IN PRODUCTION
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
namespace SabreTools.Models.DosCenter
|
||||
{
|
||||
public class DatFile
|
||||
public class MetadataFile
|
||||
{
|
||||
/// <remarks>doscenter</remarks>
|
||||
public DosCenter? DosCenter { get; set; }
|
||||
@@ -7,16 +7,16 @@ using SabreTools.Models.DosCenter;
|
||||
namespace SabreTools.Serialization
|
||||
{
|
||||
/// <summary>
|
||||
/// Serializer for DosCenter metadata files
|
||||
/// Deserializer for DosCenter metadata files
|
||||
/// </summary>
|
||||
public class DosCenter
|
||||
public partial class DosCenter
|
||||
{
|
||||
/// <summary>
|
||||
/// Deserializes a DosCenter metadata file to the defined type
|
||||
/// </summary>
|
||||
/// <param name="path">Path to the file to deserialize</param>
|
||||
/// <returns>Deserialized data on success, null on failure</returns>
|
||||
public static DatFile? Deserialize(string path)
|
||||
public static MetadataFile? Deserialize(string path)
|
||||
{
|
||||
try
|
||||
{
|
||||
@@ -35,7 +35,7 @@ namespace SabreTools.Serialization
|
||||
/// </summary>
|
||||
/// <param name="stream">Stream to deserialize</param>
|
||||
/// <returns>Deserialized data on success, null on failure</returns>
|
||||
public static DatFile? Deserialize(Stream? stream)
|
||||
public static MetadataFile? Deserialize(Stream? stream)
|
||||
{
|
||||
try
|
||||
{
|
||||
@@ -45,7 +45,7 @@ namespace SabreTools.Serialization
|
||||
|
||||
// Setup the reader and output
|
||||
var reader = new ClrMameProReader(stream, Encoding.UTF8) { DosCenter = true };
|
||||
var dat = new DatFile();
|
||||
var dat = new MetadataFile();
|
||||
|
||||
// Loop through and parse out the values
|
||||
string lastTopLevel = reader.TopLevel;
|
||||
@@ -166,9 +166,6 @@ namespace SabreTools.Serialization
|
||||
// If we're in a file block
|
||||
else if (reader.TopLevel == "game" && reader.RowType == CmpRowType.Internal)
|
||||
{
|
||||
// Create the block
|
||||
var file = new Models.DosCenter.File();
|
||||
|
||||
// If we have an unknown type, log it
|
||||
if (reader.InternalName != "file")
|
||||
{
|
||||
@@ -176,32 +173,9 @@ namespace SabreTools.Serialization
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach (var kvp in reader.Internal)
|
||||
{
|
||||
switch (kvp.Key?.ToLowerInvariant())
|
||||
{
|
||||
case "name":
|
||||
file.Name = kvp.Value;
|
||||
break;
|
||||
case "size":
|
||||
file.Size = kvp.Value;
|
||||
break;
|
||||
case "crc":
|
||||
file.CRC = kvp.Value;
|
||||
break;
|
||||
case "date":
|
||||
file.Date = kvp.Value;
|
||||
break;
|
||||
default:
|
||||
fileAdditional.Add(item: reader.CurrentLine);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Add the file to the list
|
||||
file.ADDITIONAL_ELEMENTS = fileAdditional.ToArray();
|
||||
// Create the file and add to the list
|
||||
var file = CreateFile(reader);
|
||||
files.Add(file);
|
||||
fileAdditional.Clear();
|
||||
}
|
||||
|
||||
else
|
||||
@@ -221,5 +195,40 @@ namespace SabreTools.Serialization
|
||||
return default;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Create a File object from the current reader context
|
||||
/// </summary>
|
||||
/// <param name="reader">ClrMameProReader representing the metadata file</param>
|
||||
/// <returns>File object created from the reader context</returns>
|
||||
private static Models.DosCenter.File CreateFile(ClrMameProReader reader)
|
||||
{
|
||||
var itemAdditional = new List<string>();
|
||||
var file = new Models.DosCenter.File();
|
||||
foreach (var kvp in reader.Internal)
|
||||
{
|
||||
switch (kvp.Key?.ToLowerInvariant())
|
||||
{
|
||||
case "name":
|
||||
file.Name = kvp.Value;
|
||||
break;
|
||||
case "size":
|
||||
file.Size = kvp.Value;
|
||||
break;
|
||||
case "crc":
|
||||
file.CRC = kvp.Value;
|
||||
break;
|
||||
case "date":
|
||||
file.Date = kvp.Value;
|
||||
break;
|
||||
default:
|
||||
itemAdditional.Add(item: reader.CurrentLine);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
file.ADDITIONAL_ELEMENTS = itemAdditional.ToArray();
|
||||
return file;
|
||||
}
|
||||
}
|
||||
}
|
||||
149
SabreTools.Serialization/DosCenter.Serializer.cs
Normal file
149
SabreTools.Serialization/DosCenter.Serializer.cs
Normal file
@@ -0,0 +1,149 @@
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
using SabreTools.IO.Writers;
|
||||
using SabreTools.Models.DosCenter;
|
||||
namespace SabreTools.Serialization
|
||||
{
|
||||
/// <summary>
|
||||
/// Deserializer for DosCenter metadata files
|
||||
/// </summary>
|
||||
public partial class DosCenter
|
||||
{
|
||||
/// <summary>
|
||||
/// Serializes the defined type to a DosCenter metadata file
|
||||
/// </summary>
|
||||
/// <param name="metadataFile">Data to serialize</param>
|
||||
/// <param name="path">Path to the file to serialize to</param>
|
||||
/// <returns>True on successful serialization, false otherwise</returns>
|
||||
public static bool SerializeToFile(MetadataFile? metadataFile, string path)
|
||||
{
|
||||
using var stream = SerializeToStream(metadataFile);
|
||||
if (stream == null)
|
||||
return false;
|
||||
|
||||
using var fs = System.IO.File.OpenWrite(path);
|
||||
stream.Seek(0, SeekOrigin.Begin);
|
||||
stream.CopyTo(fs);
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Serializes the defined type to a stream
|
||||
/// </summary>
|
||||
/// <param name="metadataFile">Data to serialize</param>
|
||||
/// <returns>Stream containing serialized data on success, null otherwise</returns>
|
||||
public static Stream? SerializeToStream(MetadataFile? metadataFile)
|
||||
{
|
||||
// If the metadata file is null
|
||||
if (metadataFile == null)
|
||||
return null;
|
||||
|
||||
// Setup the writer and output
|
||||
var stream = new MemoryStream();
|
||||
var writer = new ClrMameProWriter(stream, Encoding.UTF8)
|
||||
{
|
||||
Quotes = false,
|
||||
};
|
||||
|
||||
// Write the header, if it exists
|
||||
WriteHeader(metadataFile.DosCenter, writer);
|
||||
|
||||
// Write out the games, if they exist
|
||||
WriteGames(metadataFile.Game, writer);
|
||||
|
||||
// Return the stream
|
||||
return stream;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write header information to the current writer
|
||||
/// </summary>
|
||||
/// <param name="header">DosCenter representing the header information</param>
|
||||
/// <param name="writer">ClrMameProWriter representing the output</param>
|
||||
private static void WriteHeader(Models.DosCenter.DosCenter? header, ClrMameProWriter writer)
|
||||
{
|
||||
// If the header information is missing, we can't do anything
|
||||
if (header == null)
|
||||
return;
|
||||
|
||||
writer.WriteStartElement("DOSCenter");
|
||||
|
||||
writer.WriteOptionalStandalone("Name:", header.Name);
|
||||
writer.WriteOptionalStandalone("Description:", header.Description);
|
||||
writer.WriteOptionalStandalone("Version:", header.Version);
|
||||
writer.WriteOptionalStandalone("Date:", header.Date);
|
||||
writer.WriteOptionalStandalone("Author:", header.Author);
|
||||
writer.WriteOptionalStandalone("Homepage:", header.Homepage);
|
||||
writer.WriteOptionalStandalone("Comment:", header.Comment);
|
||||
|
||||
writer.WriteEndElement(); // doscenter
|
||||
writer.Flush();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write games information to the current writer
|
||||
/// </summary>
|
||||
/// <param name="games">Array of Game objects representing the games information</param>
|
||||
/// <param name="writer">ClrMameProWriter representing the output</param>
|
||||
private static void WriteGames(Game[]? games, ClrMameProWriter writer)
|
||||
{
|
||||
// If the games information is missing, we can't do anything
|
||||
if (games == null || !games.Any())
|
||||
return;
|
||||
|
||||
// Loop through and write out the games
|
||||
foreach (var game in games)
|
||||
{
|
||||
WriteGame(game, writer);
|
||||
writer.Flush();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write game information to the current writer
|
||||
/// </summary>
|
||||
/// <param name="game">Game object representing the game information</param>
|
||||
/// <param name="writer">ClrMameProWriter representing the output</param>
|
||||
private static void WriteGame(Game game, ClrMameProWriter writer)
|
||||
{
|
||||
// If the game information is missing, we can't do anything
|
||||
if (game == null)
|
||||
return;
|
||||
|
||||
writer.WriteStartElement("game");
|
||||
|
||||
// Write the standalone values
|
||||
writer.WriteRequiredStandalone("name", game.Name, throwOnError: true);
|
||||
|
||||
// Write the item values
|
||||
WriteFiles(game.File, writer);
|
||||
|
||||
writer.WriteEndElement(); // game
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write files information to the current writer
|
||||
/// </summary>
|
||||
/// <param name="files">Array of File objects to write</param>
|
||||
/// <param name="writer">ClrMameProWriter representing the output</param>
|
||||
private static void WriteFiles(Models.DosCenter.File[]? files, ClrMameProWriter writer)
|
||||
{
|
||||
// If the array is missing, we can't do anything
|
||||
if (files == null)
|
||||
return;
|
||||
|
||||
foreach (var file in files)
|
||||
{
|
||||
writer.WriteStartElement("file");
|
||||
|
||||
writer.WriteRequiredAttributeString("name", file.Name, throwOnError: true);
|
||||
writer.WriteRequiredAttributeString("size", file.Size, throwOnError: true);
|
||||
writer.WriteOptionalAttributeString("date", file.Date);
|
||||
writer.WriteRequiredAttributeString("crc", file.CRC.ToUpperInvariant(), throwOnError: true);
|
||||
|
||||
writer.WriteEndElement(); // file
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user