using System;
using System.Collections.Generic;
using System.Linq;
using SabreTools.Core;
using SabreTools.Core.Tools;
using SabreTools.DatItems;
using SabreTools.DatItems.Formats;
namespace SabreTools.DatFiles.Formats
{
///
/// Represents writing of a ClrMamePro DAT
///
internal partial class ClrMamePro : DatFile
{
///
protected override ItemType[] GetSupportedTypes()
{
return
[
ItemType.Archive,
ItemType.BiosSet,
ItemType.Chip,
ItemType.DipSwitch,
ItemType.Disk,
ItemType.Display,
ItemType.Driver,
ItemType.Input,
ItemType.Media,
ItemType.Release,
ItemType.Rom,
ItemType.Sample,
ItemType.Sound,
];
}
///
protected override List? GetMissingRequiredFields(DatItem datItem)
{
var missingFields = new List();
switch (datItem)
{
case Release release:
if (string.IsNullOrEmpty(release.GetName()))
missingFields.Add(Models.Metadata.Release.NameKey);
if (string.IsNullOrEmpty(release.GetFieldValue(Models.Metadata.Release.RegionKey)))
missingFields.Add(Models.Metadata.Release.RegionKey);
break;
case BiosSet biosset:
if (string.IsNullOrEmpty(biosset.GetName()))
missingFields.Add(Models.Metadata.BiosSet.NameKey);
if (string.IsNullOrEmpty(biosset.GetFieldValue(Models.Metadata.BiosSet.DescriptionKey)))
missingFields.Add(Models.Metadata.BiosSet.DescriptionKey);
break;
case Rom rom:
if (string.IsNullOrEmpty(rom.GetName()))
missingFields.Add(Models.Metadata.Rom.NameKey);
if (rom.GetFieldValue(Models.Metadata.Rom.SizeKey) == null || NumberHelper.ConvertToInt64(rom.GetFieldValue(Models.Metadata.Rom.SizeKey)) < 0)
missingFields.Add(Models.Metadata.Rom.SizeKey);
if (string.IsNullOrEmpty(rom.GetFieldValue(Models.Metadata.Rom.CRCKey))
&& string.IsNullOrEmpty(rom.GetFieldValue(Models.Metadata.Rom.MD5Key))
&& string.IsNullOrEmpty(rom.GetFieldValue(Models.Metadata.Rom.SHA1Key))
&& string.IsNullOrEmpty(rom.GetFieldValue(Models.Metadata.Rom.SHA256Key))
&& string.IsNullOrEmpty(rom.GetFieldValue(Models.Metadata.Rom.SHA384Key))
&& string.IsNullOrEmpty(rom.GetFieldValue(Models.Metadata.Rom.SHA512Key))
&& string.IsNullOrEmpty(rom.GetFieldValue(Models.Metadata.Rom.SpamSumKey)))
{
missingFields.Add(Models.Metadata.Rom.SHA1Key);
}
break;
case Disk disk:
if (string.IsNullOrEmpty(disk.GetName()))
missingFields.Add(Models.Metadata.Disk.NameKey);
if (string.IsNullOrEmpty(disk.GetFieldValue(Models.Metadata.Disk.MD5Key))
&& string.IsNullOrEmpty(disk.GetFieldValue(Models.Metadata.Disk.SHA1Key)))
{
missingFields.Add(Models.Metadata.Disk.SHA1Key);
}
break;
case Sample sample:
if (string.IsNullOrEmpty(sample.GetName()))
missingFields.Add(Models.Metadata.Sample.NameKey);
break;
case Archive archive:
if (string.IsNullOrEmpty(archive.GetName()))
missingFields.Add(Models.Metadata.Archive.NameKey);
break;
case Chip chip:
if (chip.GetFieldValue(Models.Metadata.Chip.ChipTypeKey) == ChipType.NULL)
missingFields.Add(Models.Metadata.Chip.ChipTypeKey);
if (string.IsNullOrEmpty(chip.GetName()))
missingFields.Add(Models.Metadata.Chip.NameKey);
break;
case Display display:
if (display.GetFieldValue(Models.Metadata.Display.DisplayTypeKey) == DisplayType.NULL)
missingFields.Add(Models.Metadata.Display.DisplayTypeKey);
if (display.GetFieldValue(Models.Metadata.Display.RotateKey) == null)
missingFields.Add(Models.Metadata.Display.RotateKey);
break;
case Sound sound:
if (sound.GetFieldValue(Models.Metadata.Sound.ChannelsKey) == null)
missingFields.Add(Models.Metadata.Sound.ChannelsKey);
break;
case Input input:
if (input.GetFieldValue(Models.Metadata.Input.PlayersKey) == null)
missingFields.Add(Models.Metadata.Input.PlayersKey);
if (!input.ControlsSpecified)
missingFields.Add(Models.Metadata.Input.ControlKey);
break;
case DipSwitch dipswitch:
if (string.IsNullOrEmpty(dipswitch.GetName()))
missingFields.Add(Models.Metadata.DipSwitch.NameKey);
break;
case Driver driver:
if (driver.GetFieldValue(Models.Metadata.Driver.StatusKey) == SupportStatus.NULL)
missingFields.Add(Models.Metadata.Driver.StatusKey);
if (driver.GetFieldValue(Models.Metadata.Driver.EmulationKey) == SupportStatus.NULL)
missingFields.Add(Models.Metadata.Driver.EmulationKey);
break;
}
return missingFields;
}
///
public override bool WriteToFile(string outfile, bool ignoreblanks = false, bool throwOnError = false)
{
try
{
logger.User($"Writing to '{outfile}'...");
//var metadataFile = CreateMetadataFile(ignoreblanks);
// Serialize the input file
var metadata = ConvertMetadata(ignoreblanks);
var metadataFile = new Serialization.CrossModel.ClrMamePro().Deserialize(metadata);
if (!(new Serialization.Files.ClrMamePro().Serialize(metadataFile, outfile, Quotes)))
{
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;
}
logger.User($"'{outfile}' written!{Environment.NewLine}");
return true;
}
#region Converters
///
/// Create a MetadataFile from the current internal information
///
/// True if blank roms should be skipped on output, false otherwise
private Models.ClrMamePro.MetadataFile CreateMetadataFile(bool ignoreblanks)
{
var metadataFile = new Models.ClrMamePro.MetadataFile
{
ClrMamePro = CreateClrMamePro(),
Game = CreateGames(ignoreblanks)
};
return metadataFile;
}
///
/// Create a ClrMamePro from the current internal information
///
private Models.ClrMamePro.ClrMamePro? CreateClrMamePro()
{
// If we don't have a header, we can't do anything
if (this.Header == null)
return null;
var clrMamePro = new Models.ClrMamePro.ClrMamePro
{
Name = Header.GetFieldValue(Models.Metadata.Header.NameKey),
Description = Header.GetFieldValue(Models.Metadata.Header.DescriptionKey),
RootDir = Header.GetFieldValue(Models.Metadata.Header.RootDirKey),
Category = Header.GetFieldValue(Models.Metadata.Header.CategoryKey),
Version = Header.GetFieldValue(Models.Metadata.Header.VersionKey),
Date = Header.GetFieldValue(Models.Metadata.Header.DateKey),
Author = Header.GetFieldValue(Models.Metadata.Header.AuthorKey),
Homepage = Header.GetFieldValue(Models.Metadata.Header.HomepageKey),
Url = Header.GetFieldValue(Models.Metadata.Header.UrlKey),
Comment = Header.GetFieldValue(Models.Metadata.Header.CommentKey),
Header = Header.GetFieldValue(Models.Metadata.Header.HeaderKey),
Type = Header.GetFieldValue(Models.Metadata.Header.TypeKey),
};
if (Header.GetFieldValue(Models.Metadata.Header.ForceMergingKey) != MergingFlag.None)
clrMamePro.ForceMerging = Header.GetFieldValue(Models.Metadata.Header.ForceMergingKey).AsStringValue(useSecond: false);
if (Header.GetFieldValue(Models.Metadata.Header.ForcePackingKey) != PackingFlag.None)
clrMamePro.ForcePacking = Header.GetFieldValue(Models.Metadata.Header.ForcePackingKey).AsStringValue(useSecond: false);
return clrMamePro;
}
///
/// Create an array of GameBase from the current internal information
///
/// True if blank roms should be skipped on output, false otherwise
private Models.ClrMamePro.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();
// 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].GetFieldValue(DatItem.MachineKey);
// We normalize to all "game"
var game = new Models.ClrMamePro.Game
{
Name = machine?.GetFieldValue(Models.Metadata.Machine.NameKey),
Description = machine?.GetFieldValue(Models.Metadata.Machine.DescriptionKey),
Year = machine?.GetFieldValue(Models.Metadata.Machine.YearKey),
Manufacturer = machine?.GetFieldValue(Models.Metadata.Machine.ManufacturerKey),
Category = machine?.GetFieldValue(Models.Metadata.Machine.CategoryKey),
CloneOf = machine?.GetFieldValue(Models.Metadata.Machine.CloneOfKey),
RomOf = machine?.GetFieldValue(Models.Metadata.Machine.RomOfKey),
SampleOf = machine?.GetFieldValue(Models.Metadata.Machine.SampleOfKey),
};
// Create holders for all item types
var releases = new List();
var biossets = new List();
var roms = new List();
var disks = new List();
var medias = new List();
var samples = new List();
var archives = new List();
var chips = new List();
var videos = new List();
var dipswitches = new List();
// Loop through and convert the items to respective lists
for (int index = 0; index < items.Count; index++)
{
// 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 Chip chip:
chips.Add(CreateChip(chip));
break;
case Display display:
videos.Add(CreateVideo(display));
break;
case Sound sound:
game.Sound = CreateSound(sound);
break;
case Input input:
game.Input = CreateInput(input);
break;
case DipSwitch dipswitch:
dipswitches.Add(CreateDipSwitch(dipswitch));
break;
case Driver driver:
game.Driver = CreateDriver(driver);
break;
}
}
// Assign the values to the game
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];
// Add the game to the list
games.Add(game);
}
return [.. games];
}
///
/// Create a Release from the current Release DatItem
///
private static Models.ClrMamePro.Release CreateRelease(Release item)
{
var release = new Models.ClrMamePro.Release
{
Name = item.GetName(),
Region = item.GetFieldValue(Models.Metadata.Release.RegionKey),
Language = item.GetFieldValue(Models.Metadata.Release.LanguageKey),
Date = item.GetFieldValue(Models.Metadata.Release.DateKey),
Default = item.GetFieldValue(Models.Metadata.Release.DefaultKey).FromYesNo(),
};
return release;
}
///
/// Create a BiosSet from the current BiosSet DatItem
///
private static Models.ClrMamePro.BiosSet CreateBiosSet(BiosSet item)
{
var biosset = new Models.ClrMamePro.BiosSet
{
Name = item.GetName(),
Default = item.GetFieldValue(Models.Metadata.BiosSet.DefaultKey).FromYesNo(),
Description = item.GetFieldValue(Models.Metadata.BiosSet.DescriptionKey),
};
return biosset;
}
///
/// Create a Rom from the current Rom DatItem
///
private static Models.ClrMamePro.Rom CreateRom(Rom item)
{
var rom = new Models.ClrMamePro.Rom
{
Name = item.GetName(),
Size = item.GetFieldValue(Models.Metadata.Rom.SizeKey),
CRC = item.GetFieldValue(Models.Metadata.Rom.CRCKey),
MD5 = item.GetFieldValue(Models.Metadata.Rom.MD5Key),
SHA1 = item.GetFieldValue(Models.Metadata.Rom.SHA1Key),
SHA256 = item.GetFieldValue(Models.Metadata.Rom.SHA256Key),
SHA384 = item.GetFieldValue(Models.Metadata.Rom.SHA384Key),
SHA512 = item.GetFieldValue(Models.Metadata.Rom.SHA512Key),
SpamSum = item.GetFieldValue(Models.Metadata.Rom.SpamSumKey),
xxHash364 = item.GetFieldValue(Models.Metadata.Rom.xxHash364Key),
xxHash3128 = item.GetFieldValue(Models.Metadata.Rom.xxHash3128Key),
Merge = item.GetFieldValue(Models.Metadata.Rom.MergeKey),
Region = item.GetFieldValue(Models.Metadata.Rom.RegionKey),
Flags = item.GetFieldValue(Models.Metadata.Rom.FlagsKey),
Date = item.GetFieldValue(Models.Metadata.Rom.DateKey),
Offs = item.GetFieldValue(Models.Metadata.Rom.OffsetKey),
Serial = item.GetFieldValue(Models.Metadata.Rom.SerialKey),
Header = item.GetFieldValue(Models.Metadata.Rom.HeaderKey),
Inverted = item.GetFieldValue(Models.Metadata.Rom.InvertedKey).FromYesNo(),
MIA = item.GetFieldValue(Models.Metadata.Rom.MIAKey).FromYesNo(),
};
if (item.ItemStatusSpecified)
rom.Status = item.GetFieldValue(Models.Metadata.Rom.StatusKey).AsStringValue(useSecond: false);
return rom;
}
///
/// Create a Disk from the current Disk DatItem
///
private static Models.ClrMamePro.Disk CreateDisk(Disk item)
{
var disk = new Models.ClrMamePro.Disk
{
Name = item.GetName(),
MD5 = item.GetFieldValue(Models.Metadata.Disk.MD5Key),
SHA1 = item.GetFieldValue(Models.Metadata.Disk.SHA1Key),
Merge = item.GetFieldValue(Models.Metadata.Disk.MergeKey),
Flags = item.GetFieldValue(Models.Metadata.Disk.FlagsKey),
};
if (item.GetFieldValue(Models.Metadata.Disk.StatusKey) != ItemStatus.NULL)
disk.Status = item.GetFieldValue(Models.Metadata.Disk.StatusKey).AsStringValue(useSecond: false);
return disk;
}
///
/// Create a Media from the current Media DatItem
///
private static Models.ClrMamePro.Media CreateMedia(Media item)
{
var media = new Models.ClrMamePro.Media
{
Name = item.GetName(),
MD5 = item.GetFieldValue(Models.Metadata.Media.MD5Key),
SHA1 = item.GetFieldValue(Models.Metadata.Media.SHA1Key),
SHA256 = item.GetFieldValue(Models.Metadata.Media.SHA256Key),
SpamSum = item.GetFieldValue(Models.Metadata.Media.SpamSumKey),
};
return media;
}
///
/// Create a Sample from the current Sample DatItem
///
private static Models.ClrMamePro.Sample CreateSample(Sample item)
{
var sample = new Models.ClrMamePro.Sample
{
Name = item.GetName(),
};
return sample;
}
///
/// Create a Archive from the current Archive DatItem
///
private static Models.ClrMamePro.Archive CreateArchive(Archive item)
{
var archive = new Models.ClrMamePro.Archive
{
Name = item.GetName(),
};
return archive;
}
///
/// Create a Chip from the current Chip DatItem
///
private static Models.ClrMamePro.Chip CreateChip(Chip item)
{
var chip = new Models.ClrMamePro.Chip
{
Type = item.GetFieldValue(Models.Metadata.Chip.ChipTypeKey).AsStringValue(),
Name = item.GetName(),
Flags = item.GetFieldValue(Models.Metadata.Chip.FlagsKey),
Clock = item.GetFieldValue(Models.Metadata.Chip.ClockKey)?.ToString(),
};
return chip;
}
///
/// Create a Video from the current Display DatItem
///
private static Models.ClrMamePro.Video CreateVideo(Display item)
{
var video = new Models.ClrMamePro.Video
{
Screen = item.GetFieldValue(Models.Metadata.Display.DisplayTypeKey).AsStringValue(),
X = item.GetFieldValue(Models.Metadata.Display.WidthKey)?.ToString(),
Y = item.GetFieldValue(Models.Metadata.Display.HeightKey)?.ToString(),
AspectX = item.GetFieldValue("ASPECTX"),
AspectY = item.GetFieldValue("ASPECTY"),
Freq = item.GetFieldValue(Models.Metadata.Display.RefreshKey)?.ToString(),
};
switch (item.GetFieldValue(Models.Metadata.Display.RotateKey))
{
case 0:
case 180:
video.Orientation = "horizontal";
break;
case 90:
case 270:
video.Orientation = "vertical";
break;
}
return video;
}
///
/// Create a Sound from the current Sound DatItem
///
private static Models.ClrMamePro.Sound CreateSound(Sound item)
{
var sound = new Models.ClrMamePro.Sound
{
Channels = item.GetFieldValue(Models.Metadata.Sound.ChannelsKey)?.ToString(),
};
return sound;
}
///
/// Create a Input from the current Input DatItem
///
private static Models.ClrMamePro.Input CreateInput(Input item)
{
var input = new Models.ClrMamePro.Input
{
Players = item.GetFieldValue(Models.Metadata.Input.PlayersKey)?.ToString(),
//Control = item.GetFieldValue(Models.Metadata.Input.ControlKey),
Coins = item.GetFieldValue(Models.Metadata.Input.CoinsKey)?.ToString(),
Tilt = item.GetFieldValue(Models.Metadata.Input.TiltKey).FromYesNo(),
Service = item.GetFieldValue(Models.Metadata.Input.ServiceKey).FromYesNo(),
};
if (item.ControlsSpecified)
input.Buttons = item.GetFieldValue(Models.Metadata.Input.ControlKey)![0].GetFieldValue(Models.Metadata.Control.ButtonsKey)?.ToString();
return input;
}
///
/// Create a DipSwitch from the current DipSwitch DatItem
///
private static Models.ClrMamePro.DipSwitch CreateDipSwitch(DipSwitch item)
{
var dipswitch = new Models.ClrMamePro.DipSwitch
{
Name = item.GetName(),
};
if (item.ValuesSpecified)
{
var entries = new List();
foreach (var setting in item.GetFieldValue(Models.Metadata.DipSwitch.DipValueKey)!)
{
entries.Add(setting.GetFieldValue(Models.Metadata.DipValue.ValueKey)!);
if (setting.GetFieldValue(Models.Metadata.DipValue.DefaultKey) == true)
dipswitch.Default = setting.GetFieldValue(Models.Metadata.DipValue.ValueKey);
}
dipswitch.Entry = [.. entries];
}
return dipswitch;
}
///
/// Create a Driver from the current Driver DatItem
///
private static Models.ClrMamePro.Driver CreateDriver(Driver item)
{
var driver = new Models.ClrMamePro.Driver
{
Status = item.GetFieldValue(Models.Metadata.Driver.StatusKey).AsStringValue(),
Color = item.GetFieldValue(Models.Metadata.Driver.ColorKey).AsStringValue(),
Sound = item.GetFieldValue(Models.Metadata.Driver.SoundKey).AsStringValue(),
PaletteSize = item.GetFieldValue(Models.Metadata.Driver.PaletteSizeKey)?.ToString(),
Blit = item.GetFieldValue(Models.Metadata.Driver.BlitKey),
};
return driver;
}
#endregion
}
}