Use Logiqx serializer for writing, fix issues

This commit is contained in:
Matt Nadareski
2023-07-31 12:51:41 -04:00
parent dfc3fba032
commit 60c79eb034
7 changed files with 564 additions and 439 deletions

View File

@@ -220,12 +220,10 @@ namespace SabreTools.DatFiles.Formats
NoIntroCloneOfId = game.CloneOfId, NoIntroCloneOfId = game.CloneOfId,
Runnable = game.Runnable.AsRunnable(), Runnable = game.Runnable.AsRunnable(),
Comment = string.Join(';', game.Comment),
Description = game.Description, Description = game.Description,
Year = game.Year, Year = game.Year,
Manufacturer = game.Manufacturer, Manufacturer = game.Manufacturer,
Publisher = game.Publisher, Publisher = game.Publisher,
Category = string.Join(';', game.Category),
}; };
if (!string.IsNullOrWhiteSpace(dirname)) if (!string.IsNullOrWhiteSpace(dirname))
@@ -238,6 +236,11 @@ namespace SabreTools.DatFiles.Formats
if (game.IsMechanical.AsYesNo() == true) if (game.IsMechanical.AsYesNo() == true)
machine.MachineType |= MachineType.Mechanical; machine.MachineType |= MachineType.Mechanical;
if (game.Comment != null && game.Comment.Any())
machine.Comment = string.Join(';', game.Comment);
if (game.Category != null && game.Category.Any())
machine.Category = string.Join(';', game.Category);
if (game.Trurip != null) if (game.Trurip != null)
{ {
var trurip = game.Trurip; var trurip = game.Trurip;
@@ -633,7 +636,7 @@ namespace SabreTools.DatFiles.Formats
} }
} }
/// <summary> /// <summary>
/// Convert SoftwareList information /// Convert SoftwareList information
/// </summary> /// </summary>
/// <param name="softwarelists">Array of deserialized models to convert</param> /// <param name="softwarelists">Array of deserialized models to convert</param>

View File

@@ -1,13 +1,10 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.Linq;
using System.Text;
using System.Xml;
using SabreTools.Core; using SabreTools.Core;
using SabreTools.Core.Tools; using SabreTools.Core.Tools;
using SabreTools.DatItems; using SabreTools.DatItems;
using SabreTools.DatItems.Formats; using SabreTools.DatItems.Formats;
using SabreTools.IO;
namespace SabreTools.DatFiles.Formats namespace SabreTools.DatFiles.Formats
{ {
@@ -34,7 +31,7 @@ namespace SabreTools.DatFiles.Formats
/// <inheritdoc/> /// <inheritdoc/>
protected override List<DatItemField> GetMissingRequiredFields(DatItem datItem) protected override List<DatItemField> GetMissingRequiredFields(DatItem datItem)
{ {
var missingFields = new List<DatItemField>(); var missingFields = new List<DatItemField>();
switch (datItem) switch (datItem)
{ {
case Release release: case Release release:
@@ -135,70 +132,21 @@ namespace SabreTools.DatFiles.Formats
try try
{ {
logger.User($"Writing to '{outfile}'..."); logger.User($"Writing to '{outfile}'...");
FileStream fs = System.IO.File.Create(outfile);
// If we get back null for some reason, just log and return var datafile = CreateDatafile(ignoreblanks);
if (fs == null)
// Only write the doctype if we don't have No-Intro data
bool success;
if (string.IsNullOrWhiteSpace(Header.NoIntroID))
success = Serialization.Logiqx.SerializeToFileWithDocType(datafile, outfile);
else
success = Serialization.Logiqx.SerializeToFile(datafile, outfile);
if (!success)
{ {
logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); logger.Warning($"File '{outfile}' could not be written! See the log for more details.");
return false; return false;
} }
XmlTextWriter xtw = new(fs, new UTF8Encoding(false))
{
Formatting = Formatting.Indented,
IndentChar = '\t',
Indentation = 1
};
// Write out the header
WriteHeader(xtw);
// 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];
// 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(xtw);
// If we have a new game, output the beginning of the new item
if (lastgame == null || lastgame.ToLowerInvariant() != datItem.Machine.Name.ToLowerInvariant())
WriteStartGame(xtw, datItem);
// Check for a "null" item
datItem = ProcessNullifiedItem(datItem);
// Write out the item if we're not ignoring
if (!ShouldIgnore(datItem, ignoreblanks))
WriteDatItem(xtw, datItem);
// Set the new data to compare against
lastgame = datItem.Machine.Name;
}
}
// Write the file footer out
WriteFooter(xtw);
logger.User($"'{outfile}' written!{Environment.NewLine}");
xtw.Dispose();
fs.Dispose();
} }
catch (Exception ex) when (!throwOnError) catch (Exception ex) when (!throwOnError)
{ {
@@ -206,290 +154,507 @@ namespace SabreTools.DatFiles.Formats
return false; return false;
} }
logger.User($"'{outfile}' written!{Environment.NewLine}");
return true; return true;
} }
/// <summary> #region Converters
/// Write out DAT header using the supplied StreamWriter
/// </summary>
/// <param name="xtw">XmlTextWriter to output to</param>
private void WriteHeader(XmlTextWriter xtw)
{
xtw.WriteStartDocument();
if (Header.NoIntroID == null)
xtw.WriteDocType("datafile", "-//Logiqx//DTD ROM Management Datafile//EN", "http://www.logiqx.com/Dats/datafile.dtd", null);
xtw.WriteStartElement("datafile"); /// <summary>
xtw.WriteOptionalAttributeString("build", Header.Build); /// Create a Datafile from the current internal information
xtw.WriteOptionalAttributeString("debug", Header.Debug.FromYesNo()); /// <summary>
if (Header.NoIntroID != null) /// <param name="ignoreblanks">True if blank roms should be skipped on output, false otherwise</param>
private Models.Logiqx.Datafile CreateDatafile(bool ignoreblanks)
{
var datafile = new Models.Logiqx.Datafile
{ {
xtw.WriteRequiredAttributeString("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance"); Build = Header.Build,
xtw.WriteRequiredAttributeString("xsi:schemaLocation", "https://datomatic.no-intro.org/stuff https://datomatic.no-intro.org/stuff/schema_nointro_datfile_v3.xsd"); Debug = Header.Debug.FromYesNo(),
Header = CreateHeader(),
Game = CreateGames(ignoreblanks)
};
if (!string.IsNullOrEmpty(Header.NoIntroID))
datafile.SchemaLocation = "https://datomatic.no-intro.org/stuff https://datomatic.no-intro.org/stuff/schema_nointro_datfile_v3.xsd";
return datafile;
}
/// <summary>
/// Create a Header from the current internal information
/// <summary>
private Models.Logiqx.Header? CreateHeader()
{
// If we don't have a header, we can't do anything
if (this.Header == null)
return null;
var header = new Models.Logiqx.Header
{
Id = Header.NoIntroID,
Name = Header.Name,
Description = Header.Description,
RootDir = Header.RootDir,
Category = Header.Category,
Version = Header.Version,
Date = Header.Date,
Author = Header.Author,
Email = Header.Email,
Homepage = Header.Homepage,
Url = Header.Url,
Comment = Header.Comment,
Type = Header.Type,
ClrMamePro = CreateClrMamePro(),
RomCenter = CreateRomCenter(),
};
return header;
}
/// <summary>
/// Create a ClrMamePro from the current internal information
/// <summary>
private Models.Logiqx.ClrMamePro? CreateClrMamePro()
{
// If we don't have subheader values, we can't do anything
if (!Header.ForceMergingSpecified
&& !Header.ForceNodumpSpecified
&& !Header.ForcePackingSpecified
&& string.IsNullOrWhiteSpace(Header.HeaderSkipper))
{
return null;
} }
xtw.WriteStartElement("header"); var subheader = new Models.Logiqx.ClrMamePro
xtw.WriteOptionalElementString("id", Header.NoIntroID);
xtw.WriteRequiredElementString("name", Header.Name);
xtw.WriteRequiredElementString("description", Header.Description);
xtw.WriteOptionalElementString("rootdir", Header.RootDir);
if (!string.IsNullOrWhiteSpace(Header.Category))
{ {
var categories = Header.Category.Split(';'); Header = Header.HeaderSkipper,
foreach (string category in categories) };
if (Header.ForceMergingSpecified)
subheader.ForceMerging = Header.ForceMerging.FromMergingFlag(romCenter: false);
if (Header.ForceNodumpSpecified)
subheader.ForceNodump = Header.ForceNodump.FromNodumpFlag();
if (Header.ForcePackingSpecified)
subheader.ForcePacking = Header.ForcePacking.FromPackingFlag(yesno: false);
return subheader;
}
/// <summary>
/// Create a RomCenter from the current internal information
/// <summary>
private Models.Logiqx.RomCenter? CreateRomCenter()
{
// If we don't have subheader values, we can't do anything
if (string.IsNullOrWhiteSpace(Header.System)
&& !Header.RomModeSpecified
&& !Header.BiosModeSpecified
&& !Header.SampleModeSpecified
&& !Header.LockRomModeSpecified
&& !Header.LockBiosModeSpecified
&& !Header.LockSampleModeSpecified)
{
return null;
}
var subheader = new Models.Logiqx.RomCenter
{
Plugin = Header.System,
};
if (Header.RomModeSpecified)
subheader.RomMode = Header.RomMode.FromMergingFlag(romCenter: true);
if (Header.BiosModeSpecified)
subheader.BiosMode = Header.BiosMode.FromMergingFlag(romCenter: true);
if (Header.SampleModeSpecified)
subheader.SampleMode = Header.SampleMode.FromMergingFlag(romCenter: true);
if (Header.LockRomModeSpecified)
subheader.LockRomMode = Header.LockRomMode.FromYesNo();
if (Header.LockBiosModeSpecified)
subheader.LockBiosMode = Header.LockBiosMode.FromYesNo();
if (Header.LockSampleModeSpecified)
subheader.LockSampleMode = Header.LockSampleMode.FromYesNo();
return subheader;
}
/// <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.Logiqx.GameBase[]? 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.Logiqx.GameBase>();
// 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;
var game = CreateGame(machine);
// Create holders for all item types
var releases = new List<Models.Logiqx.Release>();
var biossets = new List<Models.Logiqx.BiosSet>();
var roms = new List<Models.Logiqx.Rom>();
var disks = new List<Models.Logiqx.Disk>();
var medias = new List<Models.Logiqx.Media>();
var samples = new List<Models.Logiqx.Sample>();
var archives = new List<Models.Logiqx.Archive>();
var devicerefs = new List<Models.Logiqx.DeviceRef>();
var drivers = new List<Models.Logiqx.Driver>();
var softwarelists = new List<Models.Logiqx.SoftwareList>();
// Loop through and convert the items to respective lists
for (int index = 0; index < items.Count; index++)
{ {
xtw.WriteOptionalElementString("category", category); // Get the item
var item = items[index];
// Check for a "null" item
item = ProcessNullifiedItem(item);
// Skip if we're ignoring the item
if (ShouldIgnore(item, ignoreblanks))
continue;
switch (item)
{
case Release release:
releases.Add(CreateRelease(release));
break;
case BiosSet biosset:
biossets.Add(CreateBiosSet(biosset));
break;
case Rom rom:
roms.Add(CreateRom(rom));
break;
case Disk disk:
disks.Add(CreateDisk(disk));
break;
case Media media:
medias.Add(CreateMedia(media));
break;
case Sample sample:
samples.Add(CreateSample(sample));
break;
case Archive archive:
archives.Add(CreateArchive(archive));
break;
case DeviceReference deviceref:
devicerefs.Add(CreateDeviceRef(deviceref));
break;
case Driver driver:
drivers.Add(CreateDriver(driver));
break;
case DatItems.Formats.SoftwareList softwarelist:
softwarelists.Add(CreateSoftwareList(softwarelist));
break;
}
} }
}
xtw.WriteRequiredElementString("version", Header.Version);
xtw.WriteOptionalElementString("date", Header.Date);
xtw.WriteRequiredElementString("author", Header.Author);
xtw.WriteOptionalElementString("email", Header.Email);
xtw.WriteOptionalElementString("homepage", Header.Homepage);
xtw.WriteOptionalElementString("url", Header.Url);
xtw.WriteOptionalElementString("comment", Header.Comment);
xtw.WriteOptionalElementString("type", Header.Type);
if (Header.ForcePacking != PackingFlag.None // Assign the values to the game
|| Header.ForceMerging != MergingFlag.None game.Release = releases.ToArray();
|| Header.ForceNodump != NodumpFlag.None game.BiosSet = biossets.ToArray();
|| !string.IsNullOrWhiteSpace(Header.HeaderSkipper)) game.Rom = roms.ToArray();
{ game.Disk = disks.ToArray();
xtw.WriteStartElement("clrmamepro"); game.Media = medias.ToArray();
game.Sample = samples.ToArray();
game.Archive = archives.ToArray();
game.DeviceRef = devicerefs.ToArray();
game.Driver = drivers.ToArray();
game.SoftwareList = softwarelists.ToArray();
if (Header.ForcePacking != PackingFlag.None) // Add the game to the list
xtw.WriteOptionalAttributeString("forcepacking", Header.ForcePacking.FromPackingFlag(false)); games.Add(game);
if (Header.ForceMerging != MergingFlag.None)
xtw.WriteOptionalAttributeString("forcemerging", Header.ForceMerging.FromMergingFlag(false));
if (Header.ForceNodump != NodumpFlag.None)
xtw.WriteOptionalAttributeString("forcenodump", Header.ForceNodump.FromNodumpFlag());
xtw.WriteOptionalAttributeString("header", Header.HeaderSkipper);
// End clrmamepro
xtw.WriteEndElement();
} }
if (Header.System != null return games.ToArray();
|| Header.RomMode != MergingFlag.None || Header.LockRomMode != null
|| Header.BiosMode != MergingFlag.None || Header.LockBiosMode != null
|| Header.SampleMode != MergingFlag.None || Header.LockSampleMode != null)
{
xtw.WriteStartElement("romcenter");
xtw.WriteOptionalAttributeString("plugin", Header.System);
if (Header.RomMode != MergingFlag.None)
xtw.WriteOptionalAttributeString("rommode", Header.RomMode.FromMergingFlag(true));
if (Header.BiosMode != MergingFlag.None)
xtw.WriteOptionalAttributeString("biosmode", Header.BiosMode.FromMergingFlag(true));
if (Header.SampleMode != MergingFlag.None)
xtw.WriteOptionalAttributeString("samplemode", Header.SampleMode.FromMergingFlag(true));
xtw.WriteOptionalAttributeString("lockrommode", Header.LockRomMode.FromYesNo());
xtw.WriteOptionalAttributeString("lockbiosmode", Header.LockBiosMode.FromYesNo());
xtw.WriteOptionalAttributeString("locksamplemode", Header.LockSampleMode.FromYesNo());
// End romcenter
xtw.WriteEndElement();
}
// End header
xtw.WriteEndElement();
xtw.Flush();
} }
/// <summary> /// <summary>
/// Write out Game start using the supplied StreamWriter /// Create a Trurip from the current internal information
/// </summary> /// <summary>
/// <param name="xtw">XmlTextWriter to output to</param> private Models.Logiqx.GameBase? CreateGame(Machine machine)
/// <param name="datItem">DatItem object to be output</param>
private void WriteStartGame(XmlTextWriter xtw, DatItem datItem)
{ {
// No game should start with a path separator Models.Logiqx.GameBase game = _deprecated ? new Models.Logiqx.Game() : new Models.Logiqx.Machine();
datItem.Machine.Name = datItem.Machine.Name.TrimStart(Path.DirectorySeparatorChar);
// Build the state game.Name = machine.Name;
xtw.WriteStartElement(_deprecated ? "game" : "machine"); game.SourceFile = machine.SourceFile;
xtw.WriteRequiredAttributeString("name", datItem.Machine.Name); if (machine.MachineType.HasFlag(MachineType.Bios))
game.IsBios = "yes";
if (datItem.Machine.MachineType.HasFlag(MachineType.Bios)) if (machine.MachineType.HasFlag(MachineType.Device))
xtw.WriteAttributeString("isbios", "yes"); game.IsDevice = "yes";
if (datItem.Machine.MachineType.HasFlag(MachineType.Device)) if (machine.MachineType.HasFlag(MachineType.Mechanical))
xtw.WriteAttributeString("isdevice", "yes"); game.IsMechanical = "yes";
if (datItem.Machine.MachineType.HasFlag(MachineType.Mechanical)) game.CloneOf = machine.CloneOf;
xtw.WriteAttributeString("ismechanical", "yes"); game.RomOf = machine.RomOf;
game.SampleOf = machine.SampleOf;
xtw.WriteOptionalAttributeString("runnable", datItem.Machine.Runnable.FromRunnable()); game.Board = machine.Board;
xtw.WriteOptionalAttributeString("id", datItem.Machine.NoIntroId); game.RebuildTo = machine.RebuildTo;
xtw.WriteOptionalAttributeString("cloneofid", datItem.Machine.NoIntroCloneOfId); game.Id = machine.NoIntroId;
game.CloneOfId = machine.NoIntroCloneOfId;
if (!string.Equals(datItem.Machine.Name, datItem.Machine.CloneOf, StringComparison.OrdinalIgnoreCase)) game.Runnable = machine.Runnable.FromRunnable();
xtw.WriteOptionalAttributeString("cloneof", datItem.Machine.CloneOf); if (machine.Comment != null)
if (!string.Equals(datItem.Machine.Name, datItem.Machine.RomOf, StringComparison.OrdinalIgnoreCase))
xtw.WriteOptionalAttributeString("romof", datItem.Machine.RomOf);
if (!string.Equals(datItem.Machine.Name, datItem.Machine.SampleOf, StringComparison.OrdinalIgnoreCase))
xtw.WriteOptionalAttributeString("sampleof", datItem.Machine.SampleOf);
xtw.WriteOptionalElementString("comment", datItem.Machine.Comment);
xtw.WriteOptionalElementString("description", datItem.Machine.Description);
xtw.WriteOptionalElementString("year", datItem.Machine.Year);
xtw.WriteOptionalElementString("publisher", datItem.Machine.Publisher);
xtw.WriteOptionalElementString("manufacturer", datItem.Machine.Manufacturer);
xtw.WriteOptionalElementString("category", datItem.Machine.Category);
if (datItem.Machine.TitleID != null
|| datItem.Machine.Developer != null
|| datItem.Machine.Genre != null
|| datItem.Machine.Subgenre != null
|| datItem.Machine.Ratings != null
|| datItem.Machine.Score != null
|| datItem.Machine.Enabled != null
|| datItem.Machine.Crc != null
|| datItem.Machine.RelatedTo != null)
{ {
xtw.WriteStartElement("trurip"); if (machine.Comment.Contains(';'))
game.Comment = machine.Comment.Split(';');
else
game.Comment = new[] { machine.Comment };
}
game.Description = machine.Description;
game.Year = machine.Year;
game.Manufacturer = machine.Manufacturer;
game.Publisher = machine.Publisher;
if (machine.Category != null)
{
if (machine.Category.Contains(';'))
game.Category = machine.Category.Split(';');
else
game.Category = new[] { machine.Category };
}
game.Trurip = CreateTrurip(machine);
xtw.WriteOptionalElementString("titleid", datItem.Machine.TitleID); return game;
xtw.WriteOptionalElementString("publisher", datItem.Machine.Publisher); }
xtw.WriteOptionalElementString("developer", datItem.Machine.Developer);
xtw.WriteOptionalElementString("year", datItem.Machine.Year);
xtw.WriteOptionalElementString("genre", datItem.Machine.Genre);
xtw.WriteOptionalElementString("subgenre", datItem.Machine.Subgenre);
xtw.WriteOptionalElementString("ratings", datItem.Machine.Ratings);
xtw.WriteOptionalElementString("score", datItem.Machine.Score);
xtw.WriteOptionalElementString("players", datItem.Machine.Players);
xtw.WriteOptionalElementString("enabled", datItem.Machine.Enabled);
xtw.WriteOptionalElementString("titleid", datItem.Machine.TitleID);
xtw.WriteOptionalElementString("crc", datItem.Machine.Crc.FromYesNo());
xtw.WriteOptionalElementString("source", datItem.Machine.SourceFile);
xtw.WriteOptionalElementString("cloneof", datItem.Machine.CloneOf);
xtw.WriteOptionalElementString("relatedto", datItem.Machine.RelatedTo);
// End trurip /// <summary>
xtw.WriteEndElement(); /// Create a Trurip from the current internal information
/// <summary>
private static Models.Logiqx.Trurip? CreateTrurip(Machine machine)
{
// If we don't have subheader values, we can't do anything
if (string.IsNullOrWhiteSpace(machine.TitleID)
&& string.IsNullOrWhiteSpace(machine.Developer)
&& string.IsNullOrWhiteSpace(machine.Genre)
&& string.IsNullOrWhiteSpace(machine.Subgenre)
&& string.IsNullOrWhiteSpace(machine.Ratings)
&& string.IsNullOrWhiteSpace(machine.Score)
&& string.IsNullOrWhiteSpace(machine.Enabled)
&& !machine.CrcSpecified
&& string.IsNullOrWhiteSpace(machine.RelatedTo))
{
return null;
} }
xtw.Flush(); var trurip = new Models.Logiqx.Trurip
}
/// <summary>
/// Write out Game end using the supplied StreamWriter
/// </summary>
/// <param name="xtw">XmlTextWriter to output to</param>
private void WriteEndGame(XmlTextWriter xtw)
{
// End machine
xtw.WriteEndElement();
xtw.Flush();
}
/// <summary>
/// Write out DatItem using the supplied StreamWriter
/// </summary>
/// <param name="xtw">XmlTextWriter to output to</param>
/// <param name="datItem">DatItem object to be output</param>
private void WriteDatItem(XmlTextWriter xtw, DatItem datItem)
{
// Pre-process the item name
ProcessItemName(datItem, true);
// Build the state
switch (datItem.ItemType)
{ {
case ItemType.Archive: TitleID = machine.TitleID,
var archive = datItem as Archive; Publisher = machine.Publisher,
xtw.WriteStartElement("archive"); Developer = machine.Developer,
xtw.WriteRequiredAttributeString("name", archive.Name); Year = machine.Year,
xtw.WriteEndElement(); Genre = machine.Genre,
break; Subgenre = machine.Subgenre,
Ratings = machine.Ratings,
Score = machine.Score,
Players = machine.Players,
Enabled = machine.Enabled,
CRC = machine.Crc.FromYesNo(),
Source = machine.SourceFile,
CloneOf = machine.CloneOf,
RelatedTo = machine.RelatedTo,
};
case ItemType.BiosSet: return trurip;
var biosSet = datItem as BiosSet;
xtw.WriteStartElement("biosset");
xtw.WriteRequiredAttributeString("name", biosSet.Name);
xtw.WriteOptionalAttributeString("description", biosSet.Description);
xtw.WriteOptionalAttributeString("default", biosSet.Default.FromYesNo());
xtw.WriteEndElement();
break;
case ItemType.Disk:
var disk = datItem as Disk;
xtw.WriteStartElement("disk");
xtw.WriteRequiredAttributeString("name", disk.Name);
xtw.WriteOptionalAttributeString("md5", disk.MD5?.ToLowerInvariant());
xtw.WriteOptionalAttributeString("sha1", disk.SHA1?.ToLowerInvariant());
if (disk.ItemStatus != ItemStatus.None)
xtw.WriteOptionalAttributeString("status", disk.ItemStatus.FromItemStatus(false));
xtw.WriteEndElement();
break;
case ItemType.Media:
var media = datItem as Media;
xtw.WriteStartElement("media");
xtw.WriteRequiredAttributeString("name", media.Name);
xtw.WriteOptionalAttributeString("md5", media.MD5?.ToLowerInvariant());
xtw.WriteOptionalAttributeString("sha1", media.SHA1?.ToLowerInvariant());
xtw.WriteOptionalAttributeString("sha256", media.SHA256?.ToLowerInvariant());
xtw.WriteOptionalAttributeString("spamsum", media.SpamSum?.ToLowerInvariant());
xtw.WriteEndElement();
break;
case ItemType.Release:
var release = datItem as Release;
xtw.WriteStartElement("release");
xtw.WriteRequiredAttributeString("name", release.Name);
xtw.WriteOptionalAttributeString("region", release.Region);
xtw.WriteOptionalAttributeString("language", release.Language);
xtw.WriteOptionalAttributeString("date", release.Date);
xtw.WriteOptionalAttributeString("default", release.Default.FromYesNo());
xtw.WriteEndElement();
break;
case ItemType.Rom:
var rom = datItem as Rom;
xtw.WriteStartElement("rom");
xtw.WriteRequiredAttributeString("name", rom.Name);
xtw.WriteAttributeString("size", rom.Size?.ToString());
xtw.WriteOptionalAttributeString("crc", rom.CRC?.ToLowerInvariant());
xtw.WriteOptionalAttributeString("md5", rom.MD5?.ToLowerInvariant());
xtw.WriteOptionalAttributeString("sha1", rom.SHA1?.ToLowerInvariant());
xtw.WriteOptionalAttributeString("sha256", rom.SHA256?.ToLowerInvariant());
xtw.WriteOptionalAttributeString("sha384", rom.SHA384?.ToLowerInvariant());
xtw.WriteOptionalAttributeString("sha512", rom.SHA512?.ToLowerInvariant());
xtw.WriteOptionalAttributeString("spamsum", rom.SpamSum?.ToLowerInvariant());
xtw.WriteOptionalAttributeString("date", rom.Date);
if (rom.ItemStatus != ItemStatus.None)
xtw.WriteOptionalAttributeString("status", rom.ItemStatus.FromItemStatus(false));
xtw.WriteOptionalAttributeString("inverted", rom.Inverted.FromYesNo());
xtw.WriteOptionalAttributeString("mia", rom.MIA.FromYesNo());
xtw.WriteEndElement();
break;
case ItemType.Sample:
var sample = datItem as Sample;
xtw.WriteStartElement("sample");
xtw.WriteRequiredAttributeString("name", sample.Name);
xtw.WriteEndElement();
break;
}
xtw.Flush();
} }
/// <summary> /// <summary>
/// Write out DAT footer using the supplied StreamWriter /// Create a Release from the current Release DatItem
/// </summary> /// <summary>
/// <param name="xtw">XmlTextWriter to output to</param> private static Models.Logiqx.Release CreateRelease(Release item)
private void WriteFooter(XmlTextWriter xtw)
{ {
// End machine var release = new Models.Logiqx.Release
xtw.WriteEndElement(); {
Name = item.Name,
Region = item.Region,
Language = item.Language,
Date = item.Date,
};
// End datafile if (item.DefaultSpecified)
xtw.WriteEndElement(); release.Default = item.Default.FromYesNo();
xtw.Flush(); return release;
} }
/// <summary>
/// Create a BiosSet from the current BiosSet DatItem
/// <summary>
private static Models.Logiqx.BiosSet CreateBiosSet(BiosSet item)
{
var biosset = new Models.Logiqx.BiosSet
{
Name = item.Name,
Description = item.Description,
};
if (item.DefaultSpecified)
biosset.Default = item.Default.FromYesNo();
return biosset;
}
/// <summary>
/// Create a Rom from the current Rom DatItem
/// <summary>
private static Models.Logiqx.Rom CreateRom(Rom item)
{
var rom = new Models.Logiqx.Rom
{
Name = item.Name,
Size = item.Size?.ToString(),
CRC = item.CRC,
MD5 = item.MD5,
SHA1 = item.SHA1,
SHA256 = item.SHA256,
SHA384 = item.SHA384,
SHA512 = item.SHA512,
SpamSum = item.SpamSum,
//xxHash364 = item.xxHash364, // TODO: Add to internal model
//xxHash3128 = item.xxHash3128, // TODO: Add to internal model
Merge = item.MergeTag,
//Serial = item.Serial, // TODO: Add to internal model
//Header = item.Header, // TODO: Add to internal model
Date = item.Date,
};
if (item.ItemStatusSpecified)
rom.Status = item.ItemStatus.FromItemStatus(yesno: false);
if (item.InvertedSpecified)
rom.Inverted = item.Inverted.FromYesNo();
if (item.MIASpecified)
rom.MIA = item.MIA.FromYesNo();
return rom;
}
/// <summary>
/// Create a Disk from the current Disk DatItem
/// <summary>
private static Models.Logiqx.Disk CreateDisk(Disk item)
{
var disk = new Models.Logiqx.Disk
{
Name = item.Name,
MD5 = item.MD5,
SHA1 = item.SHA1,
Merge = item.MergeTag,
Region = item.Region,
};
if (item.ItemStatusSpecified)
disk.Status = item.ItemStatus.FromItemStatus(yesno: false);
return disk;
}
/// <summary>
/// Create a Media from the current Media DatItem
/// <summary>
private static Models.Logiqx.Media CreateMedia(Media item)
{
var media = new Models.Logiqx.Media
{
Name = item.Name,
MD5 = item.MD5,
SHA1 = item.SHA1,
SHA256 = item.SHA256,
SpamSum = item.SpamSum,
};
return media;
}
/// <summary>
/// Create a Sample from the current Sample DatItem
/// <summary>
private static Models.Logiqx.Sample CreateSample(Sample item)
{
var sample = new Models.Logiqx.Sample
{
Name = item.Name,
};
return sample;
}
/// <summary>
/// Create a Archive from the current Archive DatItem
/// <summary>
private static Models.Logiqx.Archive CreateArchive(Archive item)
{
var archive = new Models.Logiqx.Archive
{
Name = item.Name,
};
return archive;
}
/// <summary>
/// Create a DeviceRef from the current Chip DatItem
/// <summary>
private static Models.Logiqx.DeviceRef CreateDeviceRef(DeviceReference item)
{
var deviceref = new Models.Logiqx.DeviceRef
{
Name = item.Name,
};
return deviceref;
}
/// <summary>
/// Create a Driver from the current Driver DatItem
/// <summary>
private static Models.Logiqx.Driver CreateDriver(Driver item)
{
var driver = new Models.Logiqx.Driver
{
Status = item.Status.FromSupportStatus(),
Emulation = item.Emulation.FromSupportStatus(),
Cocktail = item.Cocktail.FromSupportStatus(),
SaveState = item.SaveState.FromSupported(true),
};
if (item.RequiresArtworkSpecified)
driver.RequiresArtwork = item.RequiresArtwork.FromYesNo();
if (item.UnofficialSpecified)
driver.Unofficial = item.Unofficial.FromYesNo();
if (item.NoSoundHardwareSpecified)
driver.NoSoundHardware = item.NoSoundHardware.FromYesNo();
if (item.IncompleteSpecified)
driver.Incomplete = item.Incomplete.FromYesNo();
return driver;
}
/// <summary>
/// Create a SoftwareList from the current SoftwareList DatItem
/// <summary>
private static Models.Logiqx.SoftwareList CreateSoftwareList(DatItems.Formats.SoftwareList item)
{
var softwarelist = new Models.Logiqx.SoftwareList
{
Tag = item.Tag,
Name = item.Name,
Filter = item.Filter,
};
if (item.StatusSpecified)
softwarelist.Status = item.Status.FromSoftwareListStatus();
return softwarelist;
}
#endregion
} }
} }

View File

@@ -13,6 +13,10 @@ namespace SabreTools.Models.Logiqx
[XmlAttribute("debug")] [XmlAttribute("debug")]
public string? Debug { get; set; } public string? Debug { get; set; }
/// <remarks>No-Intro extension</remarks>
[XmlAttribute(Namespace = "http://www.w3.org/2001/XMLSchema-instance", AttributeName = "schemaLocation")]
public string? SchemaLocation { get; set; }
[XmlElement("header")] [XmlElement("header")]
public Header? Header { get; set; } public Header? Header { get; set; }
@@ -20,21 +24,10 @@ namespace SabreTools.Models.Logiqx
[XmlElement("machine", typeof(Machine))] [XmlElement("machine", typeof(Machine))]
public GameBase[]? Game { get; set; } public GameBase[]? Game { get; set; }
#region No-Intro Extensions /// <remarks>RomVault extension</remarks>
/// <remarks>Appears after Debug</remarks>
[XmlAttribute(Namespace = "http://www.w3.org/2001/XMLSchema-instance", AttributeName = "schemaLocation")]
public string? SchemaLocation { get; set; }
#endregion
#region RomVault Extensions
[XmlElement("dir")] [XmlElement("dir")]
public Dir[]? Dir { get; set; } public Dir[]? Dir { get; set; }
#endregion
#region DO NOT USE IN PRODUCTION #region DO NOT USE IN PRODUCTION
/// <remarks>Should be empty</remarks> /// <remarks>Should be empty</remarks>

View File

@@ -22,13 +22,9 @@ namespace SabreTools.Models.Logiqx
[XmlAttribute("status")] [XmlAttribute("status")]
public string? Status { get; set; } public string? Status { get; set; }
#region MAME Extensions /// <remarks>MAME extension</remarks>
/// <remarks>Appears after Status</remarks>
[XmlAttribute("region")] [XmlAttribute("region")]
public string? Region { get; set; } public string? Region { get; set; }
#endregion
#region DO NOT USE IN PRODUCTION #region DO NOT USE IN PRODUCTION

View File

@@ -18,6 +18,14 @@ namespace SabreTools.Models.Logiqx
[XmlAttribute("isbios")] [XmlAttribute("isbios")]
public string? IsBios { get; set; } public string? IsBios { get; set; }
/// <remarks>(yes|no) "no", MAME extension</remarks>
[XmlAttribute("isdevice")]
public string? IsDevice { get; set; }
/// <remarks>(yes|no) "no", MAME extension</remarks>
[XmlAttribute("ismechanical")]
public string? IsMechanical { get; set; }
[XmlAttribute("cloneof")] [XmlAttribute("cloneof")]
public string? CloneOf { get; set; } public string? CloneOf { get; set; }
@@ -33,6 +41,14 @@ namespace SabreTools.Models.Logiqx
[XmlAttribute("rebuildto")] [XmlAttribute("rebuildto")]
public string? RebuildTo { get; set; } public string? RebuildTo { get; set; }
/// <remarks>No-Intro extension</remarks>
[XmlAttribute("id")]
public string? Id { get; set; }
/// <remarks>No-Intro extension</remarks>
[XmlAttribute("cloneofid")]
public string? CloneOfId { get; set; }
/// <remarks>(no|partial|yes) "no"</remarks> /// <remarks>(no|partial|yes) "no"</remarks>
[XmlAttribute("runnable")] [XmlAttribute("runnable")]
public string? Runnable { get; set; } public string? Runnable { get; set; }
@@ -56,6 +72,10 @@ namespace SabreTools.Models.Logiqx
[XmlElement("category")] [XmlElement("category")]
public string[]? Category { get; set; } public string[]? Category { get; set; }
/// <remarks>Trurip extension</remarks>
[XmlElement("trurip")]
public Trurip? Trurip { get; set; }
[XmlElement(elementName: "release")] [XmlElement(elementName: "release")]
public Release[]? Release { get; set; } public Release[]? Release { get; set; }
@@ -68,10 +88,12 @@ namespace SabreTools.Models.Logiqx
[XmlElement("disk")] [XmlElement("disk")]
public Disk[]? Disk { get; set; } public Disk[]? Disk { get; set; }
[XmlElement("media")] // Aaru extension /// <remarks>Aaru extension</remarks>
[XmlElement("media")]
public Media[]? Media { get; set; } public Media[]? Media { get; set; }
[XmlElement("device_ref")] // MAME extension /// <remarks>MAME extension</remarks>
[XmlElement("device_ref")]
public DeviceRef[]? DeviceRef { get; set; } public DeviceRef[]? DeviceRef { get; set; }
[XmlElement("sample")] [XmlElement("sample")]
@@ -80,44 +102,14 @@ namespace SabreTools.Models.Logiqx
[XmlElement("archive")] [XmlElement("archive")]
public Archive[]? Archive { get; set; } public Archive[]? Archive { get; set; }
[XmlElement("driver")] // MAME extension /// <remarks>MAME extension</remarks>
[XmlElement("driver")]
public Driver[]? Driver { get; set; } public Driver[]? Driver { get; set; }
[XmlElement("softwarelist")] // MAME extension /// <remarks>MAME extension</remarks>
[XmlElement("softwarelist")]
public SoftwareList[]? SoftwareList { get; set; } public SoftwareList[]? SoftwareList { get; set; }
#region MAME Extensions
/// <remarks>(yes|no) "no", Appears after IsBios</remarks>
[XmlAttribute("isdevice")]
public string? IsDevice { get; set; }
/// <remarks>(yes|no) "no", Appears after IsDevice</remarks>
[XmlAttribute("ismechanical")]
public string? IsMechanical { get; set; }
#endregion
#region No-Intro Extensions
/// <remarks>Appears after RebuildTo</remarks>
[XmlAttribute("id")]
public string? Id { get; set; }
/// <remarks>Appears after Id</remarks>
[XmlAttribute("cloneofid")]
public string? CloneOfId { get; set; }
#endregion
#region Trurip Extensions
/// <remarks>Appears after Category</remarks>
[XmlElement("trurip")]
public Trurip? Trurip { get; set; }
#endregion
#region DO NOT USE IN PRODUCTION #region DO NOT USE IN PRODUCTION
/// <remarks>Should be empty</remarks> /// <remarks>Should be empty</remarks>

View File

@@ -6,12 +6,20 @@ namespace SabreTools.Models.Logiqx
[XmlRoot("header")] [XmlRoot("header")]
public class Header public class Header
{ {
/// <remarks>No-Intro extension</remarks>
[XmlElement("id")]
public string? Id { get; set; }
[XmlElement("name")] [XmlElement("name")]
public string Name { get; set; } public string Name { get; set; }
[XmlElement("description")] [XmlElement("description")]
public string Description { get; set; } public string Description { get; set; }
/// <remarks>Trurip extension</remarks>
[XmlElement("rootdir")]
public string? RootDir { get; set; }
[XmlElement("category")] [XmlElement("category")]
public string? Category { get; set; } public string? Category { get; set; }
@@ -36,32 +44,16 @@ namespace SabreTools.Models.Logiqx
[XmlElement("comment")] [XmlElement("comment")]
public string? Comment { get; set; } public string? Comment { get; set; }
/// <remarks>Trurip extension</remarks>
[XmlElement("type")]
public string? Type { get; set; }
[XmlElement("clrmamepro")] [XmlElement("clrmamepro")]
public ClrMamePro? ClrMamePro { get; set; } public ClrMamePro? ClrMamePro { get; set; }
[XmlElement("romcenter")] [XmlElement("romcenter")]
public RomCenter? RomCenter { get; set; } public RomCenter? RomCenter { get; set; }
#region No-Intro Extensions
/// <remarks>Appears at very top</remarks>
[XmlElement("id")]
public string? Id { get; set; }
#endregion
#region Trurip Extensions
/// <remarks>Appears after Description</remarks>
[XmlElement("rootdir")]
public string? RootDir { get; set; }
/// <remarks>Appears after Comment</remarks>
[XmlElement("type")]
public string? Type { get; set; }
#endregion
#region DO NOT USE IN PRODUCTION #region DO NOT USE IN PRODUCTION
/// <remarks>Should be empty</remarks> /// <remarks>Should be empty</remarks>

View File

@@ -21,6 +21,30 @@ namespace SabreTools.Models.Logiqx
[XmlAttribute("sha1")] [XmlAttribute("sha1")]
public string? SHA1 { get; set; } public string? SHA1 { get; set; }
/// <remarks>Hash/No-Intro extension</remarks>
[XmlAttribute("sha256")]
public string? SHA256 { get; set; }
/// <remarks>Hash extension</remarks>
[XmlAttribute("sha384")]
public string? SHA384 { get; set; }
/// <remarks>Hash extension</remarks>
[XmlAttribute("sha512")]
public string? SHA512 { get; set; }
/// <remarks>Hash extension</remarks>
[XmlAttribute("spamsum")]
public string? SpamSum { get; set; }
/// <remarks>DiscImgeCreator extension</remarks>
[XmlAttribute("xxh3_64")]
public string? xxHash364 { get; set; }
/// <remarks>DiscImgeCreator extension</remarks>
[XmlAttribute("xxh3_128")]
public string? xxHash3128 { get; set; }
[XmlAttribute("merge")] [XmlAttribute("merge")]
public string? Merge { get; set; } public string? Merge { get; set; }
@@ -28,64 +52,24 @@ namespace SabreTools.Models.Logiqx
[XmlAttribute("status")] [XmlAttribute("status")]
public string? Status { get; set; } public string? Status { get; set; }
[XmlAttribute("date")] /// <remarks>No-Intro extension</remarks>
public string? Date { get; set; }
#region Hash Extensions
/// <remarks>Also in No-Intro spec; Appears after SHA1</remarks>
[XmlAttribute("sha256")]
public string? SHA256 { get; set; }
/// <remarks>Appears after SHA256</remarks>
[XmlAttribute("sha384")]
public string? SHA384 { get; set; }
/// <remarks>Appears after SHA384</remarks>
[XmlAttribute("sha512")]
public string? SHA512 { get; set; }
/// <remarks>Appears after SHA512</remarks>
[XmlAttribute("spamsum")]
public string? SpamSum { get; set; }
#endregion
#region DiscImgeCreator Extensions
/// <remarks>Appears after SpamSum</remarks>
[XmlAttribute("xxh3_64")]
public string? xxHash364 { get; set; }
/// <remarks>Appears after xxHash364</remarks>
[XmlAttribute("xxh3_128")]
public string? xxHash3128 { get; set; }
#endregion
#region No-Intro Extensions
/// <remarks>Appears after Status</remarks>
[XmlAttribute("serial")] [XmlAttribute("serial")]
public string? Serial { get; set; } public string? Serial { get; set; }
/// <remarks>Appears after Serial</remarks> /// <remarks>No-Intro extension</remarks>
[XmlAttribute("header")] [XmlAttribute("header")]
public string? Header { get; set; } public string? Header { get; set; }
#endregion [XmlAttribute("date")]
public string? Date { get; set; }
#region RomVault Extensions /// <remarks>Boolean; RomVault extension</remarks>
/// <remarks>Boolean; Appears after Date</remarks>
[XmlAttribute("inverted")] [XmlAttribute("inverted")]
public string? Inverted { get; set; } public string? Inverted { get; set; }
/// <remarks>Boolean; Appears after Inverted</remarks> /// <remarks>Boolean; RomVault extension</remarks>
[XmlAttribute("mia")] [XmlAttribute("mia")]
public string? MIA { get; set; } public string? MIA { get; set; }
#endregion
#region DO NOT USE IN PRODUCTION #region DO NOT USE IN PRODUCTION