SabreTools/SabreTools.DatFiles/Formats/OpenMSX.Reader.cs

using System;
using System.Linq;
using SabreTools.Core;
using SabreTools.Core.Tools;
using SabreTools.DatItems;
using SabreTools.DatItems.Formats;

namespace SabreTools.DatFiles.Formats
{
    /// <summary>
    /// Represents parsing an openMSX softawre list XML DAT
    /// </summary>
    internal partial class OpenMSX : DatFile
    {
        /// <inheritdoc/>
        public override void ParseFile(string filename, int indexId, bool keep, bool statsOnly = false, bool throwOnError = false)
        {
            try
            {
                // Deserialize the input file
                var softwareDb = new Serialization.Files.OpenMSX().Deserialize(filename);

                // Convert the header to the internal format
                ConvertHeader(softwareDb);

                // Convert the software data to the internal format
                ConvertSoftwares(softwareDb?.Software, 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="softwaredb">Deserialized model to convert</param>
        private void ConvertHeader(Models.OpenMSX.SoftwareDb? softwaredb)
        {
            // If the datafile is missing, we can't do anything
            if (softwaredb == null)
                return;

            Header.Name ??= "openMSX Software List";
            Header.Description ??= Header.Name;
            Header.Date ??= softwaredb.Timestamp;
        }

        /// <summary>
        /// Convert softwares information
        /// </summary>
        /// <param name="softwares">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 ConvertSoftwares(Models.OpenMSX.Software[]? softwares, string filename, int indexId, bool statsOnly)
        {
            // If the software array is missing, we can't do anything
            if (softwares == null || !softwares.Any())
                return;

            // Loop through the software and add
            foreach (var software in softwares)
            {
                ConvertSoftware(software, filename, indexId, statsOnly);
            }
        }

        /// <summary>
        /// Convert software information
        /// </summary>
        /// <param name="software">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 ConvertSoftware(Models.OpenMSX.Software software, string filename, int indexId, bool statsOnly)
        {
            // If the software is missing, we can't do anything
            if (software == null)
                return;

            // Create the machine for copying information
            var machine = new Machine();
            machine.SetFieldValue<string?>(Models.Metadata.Machine.CountryKey, software.Country);
            machine.SetFieldValue<string?>(Models.Metadata.Machine.GenMSXIDKey, software.GenMSXID);
            machine.SetFieldValue<string?>(Models.Metadata.Machine.ManufacturerKey, software.Company);
            machine.SetFieldValue<string?>(Models.Metadata.Machine.SystemKey, software.System);
            machine.SetFieldValue<string?>(Models.Metadata.Machine.NameKey, software.Title);
            machine.SetFieldValue<string?>(Models.Metadata.Machine.YearKey, software.Year);

            // Check if there are any items
            bool containsItems = false;
            ConvertDumps(software.Dump, 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 Dump information
        /// </summary>
        /// <param name="dumps">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 ConvertDumps(Models.OpenMSX.Dump[]? dumps, Machine machine, string filename, int indexId, bool statsOnly, ref bool containsItems)
        {
            // If the dumps array is missing, we can't do anything
            if (dumps == null || !dumps.Any())
                return;

            containsItems = true;
            int index = 0;
            foreach (var dump in dumps)
            {
                // If we don't have rom data, we can't do anything
                if (dump?.Rom == null)
                    continue;

                var rom = dump.Rom;

                string name = $"{machine.GetFieldValue<string?>(Models.Metadata.Machine.NameKey)}_{index++}{(!string.IsNullOrEmpty(rom.Remark) ? $" {rom.Remark}" : string.Empty)}";
                var item = new Rom
                {
                    Source = new Source { Index = indexId, Name = filename },
                };
                item.SetName(name);
                item.SetFieldValue<string?>(Models.Metadata.Rom.OffsetKey, dump.Rom?.Start);
                item.SetFieldValue<string?>(Models.Metadata.Rom.OpenMSXType, rom.Type);
                item.SetFieldValue<string?>(Models.Metadata.Rom.RemarkKey, rom.Remark);
                item.SetFieldValue<string?>(Models.Metadata.Rom.SHA1Key, rom.Hash);

                if (dump.Original != null)
                {
                    item.SetFieldValue<Original?>("ORIGINAL", new Original
                    {
                        Value = dump.Original.Value.AsYesNo(),
                        Content = dump.Original.Content,
                    });
                }

                switch (dump.Rom)
                {
                    case Models.OpenMSX.Rom:
                        item.SetFieldValue<OpenMSXSubType>(Models.Metadata.Rom.OpenMSXMediaType, OpenMSXSubType.Rom);
                        break;
                    case Models.OpenMSX.MegaRom:
                        item.SetFieldValue<OpenMSXSubType>(Models.Metadata.Rom.OpenMSXMediaType, OpenMSXSubType.MegaRom);
                        break;
                    case Models.OpenMSX.SCCPlusCart:
                        item.SetFieldValue<OpenMSXSubType>(Models.Metadata.Rom.OpenMSXMediaType, OpenMSXSubType.SCCPlusCart);
                        break;
                }

                item.CopyMachineInformation(machine);
                ParseAddHelper(item, statsOnly);
            }
        }

        #endregion
    }
}