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 DosCenter deserialization test, fix issues

Browse Source
This commit is contained in:
Matt Nadareski
2023-07-13 15:32:00 -04:00
parent 11b635e06a
commit 3ac1e7ce4e
9 changed files with 277 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
SabreTools.IO/Readers/ClrMameProReader.cs
View File

@@ -175,7 +175,7 @@ namespace SabreTools.IO.Readers
{
while (++i < linegc.Length
&& linegc[i] != "size"
&& linegc[i] != "date"
&& !(linegc[i] == "date" && char.IsDigit(linegc[i + 1][0]))
&& linegc[i] != "crc")
{
value += $" {linegc[i]}";
@@ -235,7 +235,7 @@ namespace SabreTools.IO.Readers
Internal[key] = value;
RowType = CmpRowType.Internal;
Standalone = null;
}
}
InternalName = normalizedValue;
}

2
SabreTools.Models/AttractMode/Row.cs
View File

@@ -50,7 +50,7 @@ namespace SabreTools.Models.AttractMode
#region DO NOT USE IN PRODUCTION
/// <remarks>Should be empty</remarks>
public string[] ADDITIONAL_ELEMENTS { get; set; }
public string[]? ADDITIONAL_ELEMENTS { get; set; }
#endregion
}

7
SabreTools.Models/DosCenter/DatFile.cs
View File

@@ -7,5 +7,12 @@ namespace SabreTools.Models.DosCenter
/// <remarks>game</remarks>
public Game[]? Game { get; set; }
#region DO NOT USE IN PRODUCTION
/// <remarks>Should be empty</remarks>
public string[]? ADDITIONAL_ELEMENTS { get; set; }
#endregion
}
}

7
SabreTools.Models/DosCenter/DosCenter.cs
View File

@@ -23,5 +23,12 @@ namespace SabreTools.Models.DosCenter
/// <remarks>comment</remarks>
public string? Comment { get; set; }
#region DO NOT USE IN PRODUCTION
/// <remarks>Should be empty</remarks>
public string[] ADDITIONAL_ELEMENTS { get; set; }
#endregion
}
}

11
SabreTools.Models/DosCenter/File.cs
View File

@@ -6,13 +6,20 @@ namespace SabreTools.Models.DosCenter
/// <remarks>name, attribute</remarks>
public string? Name { get; set; }
/// <remarks>size, attribute</remarks>
public long? Size { get; set; }
/// <remarks>size, attribute, numeric</remarks>
public string? Size { get; set; }
/// <remarks>crc, attribute</remarks>
public string? CRC { get; set; }
/// <remarks>date, attribute</remarks>
public string? Date { get; set; }
#region DO NOT USE IN PRODUCTION
/// <remarks>Should be empty</remarks>
public string[]? ADDITIONAL_ELEMENTS { get; set; }
#endregion
}
}

7
SabreTools.Models/DosCenter/Game.cs
View File

@@ -8,5 +8,12 @@ namespace SabreTools.Models.DosCenter
/// <remarks>file</remarks>
public File[]? File { get; set; }
#region DO NOT USE IN PRODUCTION
/// <remarks>Should be empty</remarks>
public string[]? ADDITIONAL_ELEMENTS { get; set; }
#endregion
}
}

218
SabreTools.Serialization/DosCenter.cs Normal file
View File

@@ -0,0 +1,218 @@
using System.Collections.Generic;
using System.IO;
using System.Text;
using SabreTools.IO.Readers;
using SabreTools.Models.DosCenter;
namespace SabreTools.Serialization
{
/// <summary>
/// Serializer for DosCenter metadata files
/// </summary>
public 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)
{
try
{
using var stream = PathProcessor.OpenStream(path);
return Deserialize(stream);
}
catch
{
// TODO: Handle logging the exception
return default;
}
}
/// <summary>
/// Deserializes a DosCenter metadata file in a stream to the defined type
/// </summary>
/// <param name="stream">Stream to deserialize</param>
/// <returns>Deserialized data on success, null on failure</returns>
public static DatFile? Deserialize(Stream? stream)
{
try
{
// If the stream is null
if (stream == null)
return default;
// Setup the reader and output
var reader = new ClrMameProReader(stream, Encoding.UTF8) { DosCenter = true };
var dat = new DatFile();
// Loop through and parse out the values
string lastTopLevel = reader.TopLevel;
Game? game = null;
var games = new List<Game?>();
var files = new List<Models.DosCenter.File?>();
var additional = new List<string>();
var headerAdditional = new List<string>();
var gameAdditional = new List<string>();
var fileAdditional = new List<string>();
while (!reader.EndOfStream)
{
// If we have no next line
if (!reader.ReadNextLine())
break;
// Ignore certain row types
switch (reader.RowType)
{
case CmpRowType.None:
case CmpRowType.Comment:
continue;
case CmpRowType.EndTopLevel:
switch (lastTopLevel)
{
case "doscenter":
dat.DosCenter.ADDITIONAL_ELEMENTS = headerAdditional.ToArray();
headerAdditional.Clear();
break;
case "game":
game.File = files.ToArray();
game.ADDITIONAL_ELEMENTS = gameAdditional.ToArray();
games.Add(game);
game = null;
files.Clear();
gameAdditional.Clear();
break;
default:
// No-op
break;
}
continue;
}
// If we're at the root
if (reader.RowType == CmpRowType.TopLevel)
{
lastTopLevel = reader.TopLevel;
switch (reader.TopLevel)
{
case "doscenter":
dat.DosCenter = new Models.DosCenter.DosCenter();
break;
case "game":
game = new Game();
break;
default:
additional.Add(reader.CurrentLine);
break;
}
}
// If we're in the doscenter block
else if (reader.TopLevel == "doscenter" && reader.RowType == CmpRowType.Standalone)
{
// Create the block if we haven't already
dat.DosCenter ??= new Models.DosCenter.DosCenter();
switch (reader.Standalone?.Key?.ToLowerInvariant())
{
case "name:":
dat.DosCenter.Name = reader.Standalone?.Value;
break;
case "description:":
dat.DosCenter.Description = reader.Standalone?.Value;
break;
case "version:":
dat.DosCenter.Version = reader.Standalone?.Value;
break;
case "date:":
dat.DosCenter.Date = reader.Standalone?.Value;
break;
case "author:":
dat.DosCenter.Author = reader.Standalone?.Value;
break;
case "homepage:":
dat.DosCenter.Homepage = reader.Standalone?.Value;
break;
case "comment:":
dat.DosCenter.Comment = reader.Standalone?.Value;
break;
default:
headerAdditional.Add(item: reader.CurrentLine);
break;
}
}
// If we're in a game block
else if (reader.TopLevel == "game" && reader.RowType == CmpRowType.Standalone)
{
// Create the block if we haven't already
game ??= new Game();
switch (reader.Standalone?.Key?.ToLowerInvariant())
{
case "name":
game.Name = reader.Standalone?.Value;
break;
default:
gameAdditional.Add(item: reader.CurrentLine);
break;
}
}
// 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();
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();
files.Add(file);
fileAdditional.Clear();
}
else
{
additional.Add(item: reader.CurrentLine);
}
}
// Add extra pieces and return
dat.Game = games.ToArray();
dat.ADDITIONAL_ELEMENTS = additional.ToArray();
return dat;
}
catch
{
// TODO: Handle logging the exception
return default;
}
}
}
}

26
SabreTools.Test/Parser/SerializationTests.cs
View File

@@ -48,6 +48,32 @@ namespace SabreTools.Test.Parser
}
}
[Fact]
public void DosCenterDeserializeTest()
{
// Open the file for reading
string filename = System.IO.Path.Combine(Environment.CurrentDirectory, "TestData", "test-doscenter-files.dat.gz");
// Deserialize the file
var dat = Serialization.DosCenter.Deserialize(filename);
// Validate the values
Assert.NotNull(dat?.DosCenter);
Assert.Equal(34965, dat.Game.Length);
// Validate we're not missing any attributes or elements
Assert.Empty(dat.ADDITIONAL_ELEMENTS);
Assert.Empty(dat.DosCenter.ADDITIONAL_ELEMENTS);
foreach (var game in dat.Game)
{
Assert.Empty(game.ADDITIONAL_ELEMENTS);
foreach (var file in game.File)
{
Assert.Empty(file.ADDITIONAL_ELEMENTS);
}
}
}
[Fact]
public void ListxmlDeserializeTest()
{

BIN
SabreTools.Test/TestData/test-doscenter-files.dat.gz Normal file
View File

Binary file not shown.