Files
SabreTools.Serialization/SabreTools.Serialization.Readers/ClrMamePro.cs
Matt Nadareski 8f49e190d8 Fix everything
2026-03-24 19:17:25 -04:00

977 lines
37 KiB
C#

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using SabreTools.Data.Models.ClrMamePro;
using SabreTools.Text.ClrMamePro;
#pragma warning disable CA1822 // Mark members as static
namespace SabreTools.Serialization.Readers
{
public class ClrMamePro : BaseBinaryReader<MetadataFile>
{
#region IByteReader
/// <inheritdoc/>
public override MetadataFile? Deserialize(byte[]? data, int offset)
=> Deserialize(data, offset, true);
/// <inheritdoc cref="Deserialize(byte[], int)"/>
public MetadataFile? Deserialize(byte[]? data, int offset, bool quotes)
{
// If the data is invalid
if (data is null || data.Length == 0)
return default;
// If the offset is out of bounds
if (offset < 0 || offset >= data.Length)
return default;
// Create a memory stream and parse that
var dataStream = new MemoryStream(data, offset, data.Length - offset);
return Deserialize(dataStream, quotes);
}
#endregion
#region IFileReader
/// <inheritdoc/>
public override MetadataFile? Deserialize(string? path)
=> Deserialize(path, true);
/// <inheritdoc cref="Deserialize(string?)"/>
public MetadataFile? Deserialize(string? path, bool quotes)
{
try
{
// If we don't have a file
if (string.IsNullOrEmpty(path) || !File.Exists(path))
return default;
// Open the file for deserialization
using var stream = File.Open(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
return Deserialize(stream, quotes);
}
catch
{
// TODO: Handle logging the exception
return default;
}
}
#endregion
#region IStreamReader
/// <inheritdoc/>
public override MetadataFile? Deserialize(Stream? data)
=> Deserialize(data, true);
/// <inheritdoc cref="Deserialize(Stream)"/>
public MetadataFile? Deserialize(Stream? data, bool quotes)
{
// If the data is invalid
if (data is null || !data.CanRead)
return null;
try
{
// Setup the reader and output
var reader = new Reader(data, Encoding.UTF8) { Quotes = quotes };
var dat = new MetadataFile();
// Loop through and parse out the values
string? lastTopLevel = reader.TopLevel;
GameBase? game = null;
var games = new List<GameBase>();
var releases = new List<Release>();
var biosSets = new List<BiosSet>();
var roms = new List<Rom>();
var disks = new List<Disk>();
var medias = new List<Media>();
var samples = new List<Sample>();
var archives = new List<Archive>();
var chips = new List<Chip>();
var videos = new List<Video>();
var dipSwitches = new List<DipSwitch>();
var sources = 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 "game":
case "machine":
case "resource":
case "set":
if (game is not null)
{
game.Release = [.. releases];
game.BiosSet = [.. biosSets];
game.Rom = [.. roms];
game.Disk = [.. disks];
game.Media = [.. medias];
game.Sample = [.. samples];
game.Archive = [.. archives];
game.Chip = [.. chips];
game.Video = [.. videos];
game.DipSwitch = [.. dipSwitches];
games.Add(game);
game = null;
}
releases.Clear();
biosSets.Clear();
roms.Clear();
disks.Clear();
medias.Clear();
samples.Clear();
archives.Clear();
chips.Clear();
videos.Clear();
dipSwitches.Clear();
break;
case "info":
dat.Info?.Source = [.. sources];
sources.Clear();
break;
default:
// TODO: Log invalid values
break;
}
continue;
case CmpRowType.TopLevel:
case CmpRowType.Standalone:
case CmpRowType.Internal:
break;
default:
// TODO: Log invalid values
break;
}
// If we're at the root
if (reader.RowType == CmpRowType.TopLevel)
{
lastTopLevel = reader.TopLevel;
switch (reader.TopLevel)
{
case "clrmamepro":
dat.ClrMamePro = new Data.Models.ClrMamePro.ClrMamePro();
break;
case "game":
game = new Game();
break;
case "info":
dat.Info = new Info();
break;
case "machine":
game = new Machine();
break;
case "resource":
game = new Resource();
break;
case "set":
game = new Set();
break;
default:
// TODO: Log invalid values
break;
}
}
// If we're in the clrmamepro block
else if (reader.TopLevel == "clrmamepro"
&& reader.RowType == CmpRowType.Standalone)
{
// Create the block if we haven't already
dat.ClrMamePro ??= new Data.Models.ClrMamePro.ClrMamePro();
switch (reader.Standalone?.Key?.ToLowerInvariant())
{
case "name":
dat.ClrMamePro.Name = reader.Standalone?.Value;
break;
case "description":
dat.ClrMamePro.Description = reader.Standalone?.Value;
break;
case "rootdir":
dat.ClrMamePro.RootDir = reader.Standalone?.Value;
break;
case "category":
dat.ClrMamePro.Category = reader.Standalone?.Value;
break;
case "version":
dat.ClrMamePro.Version = reader.Standalone?.Value;
break;
case "date":
dat.ClrMamePro.Date = reader.Standalone?.Value;
break;
case "author":
dat.ClrMamePro.Author = reader.Standalone?.Value;
break;
case "homepage":
dat.ClrMamePro.Homepage = reader.Standalone?.Value;
break;
case "url":
dat.ClrMamePro.Url = reader.Standalone?.Value;
break;
case "comment":
dat.ClrMamePro.Comment = reader.Standalone?.Value;
break;
case "header":
dat.ClrMamePro.Header = reader.Standalone?.Value;
break;
case "type":
dat.ClrMamePro.Type = reader.Standalone?.Value;
break;
case "forcemerging":
dat.ClrMamePro.ForceMerging = reader.Standalone?.Value;
break;
case "forcezipping":
dat.ClrMamePro.ForceZipping = reader.Standalone?.Value;
break;
case "forcepacking":
dat.ClrMamePro.ForcePacking = reader.Standalone?.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
// If we're in a game, machine, resource, or set block
else if ((reader.TopLevel == "game"
|| reader.TopLevel == "machine"
|| reader.TopLevel == "resource"
|| reader.TopLevel == "set")
&& reader.RowType == CmpRowType.Standalone)
{
// Create the block if we haven't already
game ??= reader.TopLevel switch
{
"game" => new Game(),
"machine" => new Machine(),
"resource" => new Resource(),
"set" => new Set(),
_ => throw new FormatException($"Unknown top-level block: {reader.TopLevel}"),
};
switch (reader.Standalone?.Key?.ToLowerInvariant())
{
case "name":
game.Name = reader.Standalone?.Value;
break;
case "description":
game.Description = reader.Standalone?.Value;
break;
case "driverstatus":
game.DriverStatus = reader.Standalone?.Value;
break;
case "year":
game.Year = reader.Standalone?.Value;
break;
case "manufacturer":
game.Manufacturer = reader.Standalone?.Value;
break;
case "category":
game.Category = reader.Standalone?.Value;
break;
case "cloneof":
game.CloneOf = reader.Standalone?.Value;
break;
case "romof":
game.RomOf = reader.Standalone?.Value;
break;
case "sampleof":
game.SampleOf = reader.Standalone?.Value;
break;
case "sample":
var sample = new Sample
{
Name = reader.Standalone?.Value ?? string.Empty,
};
samples.Add(sample);
break;
default:
// TODO: Log invalid values
break;
}
}
// If we're in an info block
else if (reader.TopLevel == "info"
&& reader.RowType == CmpRowType.Standalone)
{
switch (reader.Standalone?.Key?.ToLowerInvariant())
{
case "source":
string? source = reader.Standalone?.Value;
if (source is not null)
sources.Add(source);
break;
default:
// TODO: Log invalid values
break;
}
}
// If we're in an item block
else if ((reader.TopLevel == "game"
|| reader.TopLevel == "machine"
|| reader.TopLevel == "resource"
|| reader.TopLevel == "set")
&& game is not null
&& reader.RowType == CmpRowType.Internal)
{
// Create the block
switch (reader.InternalName)
{
case "release":
var release = CreateRelease(reader);
if (release is not null)
releases.Add(release);
break;
case "biosset":
var biosSet = CreateBiosSet(reader);
if (biosSet is not null)
biosSets.Add(biosSet);
break;
case "rom":
var rom = CreateRom(reader);
if (rom is not null)
roms.Add(rom);
break;
case "disk":
var disk = CreateDisk(reader);
if (disk is not null)
disks.Add(disk);
break;
case "media":
var media = CreateMedia(reader);
if (media is not null)
medias.Add(media);
break;
case "sample":
var sample = CreateSample(reader);
if (sample is not null)
samples.Add(sample);
break;
case "archive":
var archive = CreateArchive(reader);
if (archive is not null)
archives.Add(archive);
break;
case "chip":
var chip = CreateChip(reader);
if (chip is not null)
chips.Add(chip);
break;
case "video":
var video = CreateVideo(reader);
if (video is not null)
videos.Add(video);
break;
case "sound":
var sound = CreateSound(reader);
if (sound is not null)
game.Sound = sound;
break;
case "input":
var input = CreateInput(reader);
if (input is not null)
game.Input = input;
break;
case "dipswitch":
var dipSwitch = CreateDipSwitch(reader);
if (dipSwitch is not null)
dipSwitches.Add(dipSwitch);
break;
case "driver":
var driver = CreateDriver(reader);
if (driver is not null)
game.Driver = driver;
break;
default:
// TODO: Log invalid values
break;
}
}
}
// Add extra pieces and return
if (games.Count > 0)
{
dat.Game = [.. games];
return dat;
}
return null;
}
catch
{
// Ignore the actual error
return null;
}
}
/// <summary>
/// Create a Release object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>Release object created from the reader context</returns>
private static Release? CreateRelease(Reader reader)
{
if (reader.Internal is null)
return null;
var itemAdditional = new List<string>();
var release = new Release();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "name":
release.Name = kvp.Value;
break;
case "region":
release.Region = kvp.Value;
break;
case "language":
release.Language = kvp.Value;
break;
case "date":
release.Date = kvp.Value;
break;
case "default":
release.Default = kvp.Value;
break;
default:
itemAdditional.Add($"{kvp.Key}: {kvp.Value}");
break;
}
}
return release;
}
/// <summary>
/// Create a BiosSet object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>BiosSet object created from the reader context</returns>
private static BiosSet? CreateBiosSet(Reader reader)
{
if (reader.Internal is null)
return null;
var biosset = new BiosSet();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "name":
biosset.Name = kvp.Value;
break;
case "description":
biosset.Description = kvp.Value;
break;
case "default":
biosset.Default = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
return biosset;
}
/// <summary>
/// Create a Rom object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>Rom object created from the reader context</returns>
private static Rom? CreateRom(Reader reader)
{
if (reader.Internal is null)
return null;
var rom = new Rom();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "name":
rom.Name = kvp.Value;
break;
case "size":
rom.Size = kvp.Value;
break;
case "crc":
rom.CRC = kvp.Value;
break;
case "crc16":
rom.CRC16 = kvp.Value;
break;
case "crc64":
rom.CRC64 = kvp.Value;
break;
case "md2":
rom.MD2 = kvp.Value;
break;
case "md4":
rom.MD4 = kvp.Value;
break;
case "md5":
rom.MD5 = kvp.Value;
break;
case "ripemd128":
rom.RIPEMD128 = kvp.Value;
break;
case "ripemd160":
rom.RIPEMD160 = kvp.Value;
break;
case "sha1":
rom.SHA1 = kvp.Value;
break;
case "sha256":
rom.SHA256 = kvp.Value;
break;
case "sha384":
rom.SHA384 = kvp.Value;
break;
case "sha512":
rom.SHA512 = kvp.Value;
break;
case "spamsum":
rom.SpamSum = kvp.Value;
break;
case "xxh3_64":
rom.xxHash364 = kvp.Value;
break;
case "xxh3_128":
rom.xxHash3128 = kvp.Value;
break;
case "merge":
rom.Merge = kvp.Value;
break;
case "status":
rom.Status = kvp.Value;
break;
case "region":
rom.Region = kvp.Value;
break;
case "flags":
rom.Flags = kvp.Value;
break;
case "offs":
rom.Offs = kvp.Value;
break;
case "serial":
rom.Serial = kvp.Value;
break;
case "header":
rom.Header = kvp.Value;
break;
case "date":
rom.Date = kvp.Value;
break;
case "inverted":
rom.Inverted = kvp.Value;
break;
case "mia":
rom.MIA = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
return rom;
}
/// <summary>
/// Create a Disk object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>Disk object created from the reader context</returns>
private static Disk? CreateDisk(Reader reader)
{
if (reader.Internal is null)
return null;
var disk = new Disk();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "name":
disk.Name = kvp.Value;
break;
case "md5":
disk.MD5 = kvp.Value;
break;
case "sha1":
disk.SHA1 = kvp.Value;
break;
case "merge":
disk.Merge = kvp.Value;
break;
case "status":
disk.Status = kvp.Value;
break;
case "flags":
disk.Flags = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
return disk;
}
/// <summary>
/// Create a Media object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>Media object created from the reader context</returns>
private static Media? CreateMedia(Reader reader)
{
if (reader.Internal is null)
return null;
var media = new Media();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "name":
media.Name = kvp.Value;
break;
case "md5":
media.MD5 = kvp.Value;
break;
case "sha1":
media.SHA1 = kvp.Value;
break;
case "sha256":
media.SHA256 = kvp.Value;
break;
case "spamsum":
media.SpamSum = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
return media;
}
/// <summary>
/// Create a Sample object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>Sample object created from the reader context</returns>
private static Sample? CreateSample(Reader reader)
{
if (reader.Internal is null)
return null;
var sample = new Sample();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "name":
sample.Name = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
return sample;
}
/// <summary>
/// Create a Archive object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>Archive object created from the reader context</returns>
private static Archive? CreateArchive(Reader reader)
{
if (reader.Internal is null)
return null;
var archive = new Archive();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "name":
archive.Name = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
return archive;
}
/// <summary>
/// Create a Chip object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>Chip object created from the reader context</returns>
private static Chip? CreateChip(Reader reader)
{
if (reader.Internal is null)
return null;
var chip = new Chip();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "type":
chip.Type = kvp.Value;
break;
case "name":
chip.Name = kvp.Value;
break;
case "flags":
chip.Flags = kvp.Value;
break;
case "clock":
chip.Clock = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
return chip;
}
/// <summary>
/// Create a Video object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>Video object created from the reader context</returns>
private static Video? CreateVideo(Reader reader)
{
if (reader.Internal is null)
return null;
var video = new Video();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "screen":
video.Screen = kvp.Value;
break;
case "orientation":
video.Orientation = kvp.Value;
break;
case "x":
video.X = kvp.Value;
break;
case "y":
video.Y = kvp.Value;
break;
case "aspectx":
video.AspectX = kvp.Value;
break;
case "aspecty":
video.AspectY = kvp.Value;
break;
case "freq":
video.Freq = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
return video;
}
/// <summary>
/// Create a Sound object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>Sound object created from the reader context</returns>
private static Sound? CreateSound(Reader reader)
{
if (reader.Internal is null)
return null;
var sound = new Sound();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "channels":
sound.Channels = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
return sound;
}
/// <summary>
/// Create a Input object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>Input object created from the reader context</returns>
private static Input? CreateInput(Reader reader)
{
if (reader.Internal is null)
return null;
var input = new Input();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "players":
input.Players = kvp.Value;
break;
case "control":
input.Control = kvp.Value;
break;
case "buttons":
input.Buttons = kvp.Value;
break;
case "coins":
input.Coins = kvp.Value;
break;
case "tilt":
input.Tilt = kvp.Value;
break;
case "service":
input.Service = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
return input;
}
/// <summary>
/// Create a DipSwitch object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>DipSwitch object created from the reader context</returns>
private static DipSwitch? CreateDipSwitch(Reader reader)
{
if (reader.Internal is null)
return null;
var dipswitch = new DipSwitch();
var entries = new List<string>();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "name":
dipswitch.Name = kvp.Value;
break;
case "entry":
entries.Add(kvp.Value);
break;
case "default":
dipswitch.Default = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
dipswitch.Entry = [.. entries];
return dipswitch;
}
/// <summary>
/// Create a Driver object from the current reader context
/// </summary>
/// <param name="reader">Reader representing the metadata file</param>
/// <returns>Driver object created from the reader context</returns>
private static Driver? CreateDriver(Reader reader)
{
if (reader.Internal is null)
return null;
var driver = new Driver();
foreach (var kvp in reader.Internal)
{
switch (kvp.Key?.ToLowerInvariant())
{
case "status":
driver.Status = kvp.Value;
break;
case "color":
driver.Color = kvp.Value;
break;
case "sound":
driver.Sound = kvp.Value;
break;
case "palettesize":
driver.PaletteSize = kvp.Value;
break;
case "blit":
driver.Blit = kvp.Value;
break;
default:
// TODO: Log invalid values
break;
}
}
return driver;
}
#endregion
}
}