using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Text; using SabreTools.Core; using SabreTools.Core.Tools; using SabreTools.DatItems; using Newtonsoft.Json; using Newtonsoft.Json.Linq; using Newtonsoft.Json.Serialization; namespace SabreTools.DatFiles.Formats { /// /// Represents parsing and writing of a reference SabreDAT JSON /// internal class SabreJSON : DatFile { /// /// Constructor designed for casting a base DatFile /// /// Parent DatFile to copy from public SabreJSON(DatFile datFile) : base(datFile) { } /// /// Parse a reference JSON DAT and return all found games and roms within /// /// Name of the file to be parsed /// Index ID for the DAT /// True if full pathnames are to be kept, false otherwise (default) /// True if the error that is thrown should be thrown back to the caller, false otherwise protected override void ParseFile(string filename, int indexId, bool keep, bool throwOnError = false) { // Prepare all internal variables StreamReader sr = new StreamReader(File.OpenRead(filename), new UTF8Encoding(false)); JsonTextReader jtr = new JsonTextReader(sr); // If we got a null reader, just return if (jtr == null) return; // Otherwise, read the file to the end try { jtr.Read(); while (!sr.EndOfStream) { // Skip everything not a property name if (jtr.TokenType != JsonToken.PropertyName) { jtr.Read(); continue; } switch (jtr.Value) { // Header value case "header": ReadHeader(jtr); jtr.Read(); break; // Machine array case "machines": ReadMachines(jtr, filename, indexId); jtr.Read(); break; default: jtr.Read(); break; } } } catch (Exception ex) { logger.Warning($"Exception found while parsing '{filename}': {ex}"); if (throwOnError) throw ex; } jtr.Close(); } /// /// Read header information /// /// JsonTextReader to use to parse the header private void ReadHeader(JsonTextReader jtr) { // If the reader is invalid, skip if (jtr == null) return; // Read in the header and apply any new fields jtr.Read(); JsonSerializer js = new JsonSerializer(); DatHeader header = js.Deserialize(jtr); Header.ConditionalCopy(header); } /// /// Read machine array information /// /// JsonTextReader to use to parse the machine /// Name of the file to be parsed /// Index ID for the DAT private void ReadMachines(JsonTextReader jtr, string filename, int indexId) { // If the reader is invalid, skip if (jtr == null) return; // Read in the machine array jtr.Read(); JsonSerializer js = new JsonSerializer(); JArray machineArray = js.Deserialize(jtr); // Loop through each machine object and process foreach (JObject machineObj in machineArray) { ReadMachine(machineObj, filename, indexId); } } /// /// Read machine object information /// /// JObject representing a single machine /// Name of the file to be parsed /// Index ID for the DAT private void ReadMachine(JObject machineObj, string filename, int indexId) { // If object is invalid, skip it if (machineObj == null) return; // Prepare internal variables Machine machine = null; // Read the machine info, if possible if (machineObj.ContainsKey("machine")) machine = machineObj["machine"].ToObject(); // Read items, if possible if (machineObj.ContainsKey("items")) ReadItems(machineObj["items"] as JArray, filename, indexId, machine); } /// /// Read item array information /// /// JArray representing the items list /// Name of the file to be parsed /// Index ID for the DAT /// Machine information to add to the parsed items private void ReadItems( JArray itemsArr, // Standard Dat parsing string filename, int indexId, // Miscellaneous Machine machine) { // If the array is invalid, skip if (itemsArr == null) return; // Loop through each datitem object and process foreach (JObject itemObj in itemsArr) { ReadItem(itemObj, filename, indexId, machine); } } /// /// Read item information /// /// JObject representing a single datitem /// Name of the file to be parsed /// Index ID for the DAT /// Machine information to add to the parsed items private void ReadItem( JObject itemObj, // Standard Dat parsing string filename, int indexId, // Miscellaneous Machine machine) { // If we have an empty item, skip it if (itemObj == null) return; // Prepare internal variables DatItem datItem = null; // Read the datitem info, if possible if (itemObj.ContainsKey("datitem")) { JToken datItemObj = itemObj["datitem"]; switch (datItemObj.Value("type").AsItemType()) { case ItemType.Adjuster: datItem = datItemObj.ToObject(); break; case ItemType.Analog: datItem = datItemObj.ToObject(); break; case ItemType.Archive: datItem = datItemObj.ToObject(); break; case ItemType.BiosSet: datItem = datItemObj.ToObject(); break; case ItemType.Blank: datItem = datItemObj.ToObject(); break; case ItemType.Chip: datItem = datItemObj.ToObject(); break; case ItemType.Condition: datItem = datItemObj.ToObject(); break; case ItemType.Configuration: datItem = datItemObj.ToObject(); break; case ItemType.Control: datItem = datItemObj.ToObject(); break; case ItemType.DataArea: datItem = datItemObj.ToObject(); break; case ItemType.Device: datItem = datItemObj.ToObject(); break; case ItemType.DeviceReference: datItem = datItemObj.ToObject(); break; case ItemType.DipSwitch: datItem = datItemObj.ToObject(); break; case ItemType.Disk: datItem = datItemObj.ToObject(); break; case ItemType.DiskArea: datItem = datItemObj.ToObject(); break; case ItemType.Display: datItem = datItemObj.ToObject(); break; case ItemType.Driver: datItem = datItemObj.ToObject(); break; case ItemType.Extension: datItem = datItemObj.ToObject(); break; case ItemType.Feature: datItem = datItemObj.ToObject(); break; case ItemType.Info: datItem = datItemObj.ToObject(); break; case ItemType.Input: datItem = datItemObj.ToObject(); break; case ItemType.Instance: datItem = datItemObj.ToObject(); break; case ItemType.Location: datItem = datItemObj.ToObject(); break; case ItemType.Media: datItem = datItemObj.ToObject(); break; case ItemType.Part: datItem = datItemObj.ToObject(); break; case ItemType.PartFeature: datItem = datItemObj.ToObject(); break; case ItemType.Port: datItem = datItemObj.ToObject(); break; case ItemType.RamOption: datItem = datItemObj.ToObject(); break; case ItemType.Release: datItem = datItemObj.ToObject(); break; case ItemType.Rom: datItem = datItemObj.ToObject(); break; case ItemType.Sample: datItem = datItemObj.ToObject(); break; case ItemType.Setting: datItem = datItemObj.ToObject(); break; case ItemType.SharedFeature: datItem = datItemObj.ToObject(); break; case ItemType.Slot: datItem = datItemObj.ToObject(); break; case ItemType.SlotOption: datItem = datItemObj.ToObject(); break; case ItemType.SoftwareList: datItem = datItemObj.ToObject(); break; case ItemType.Sound: datItem = datItemObj.ToObject(); break; } } // If we got a valid datitem, copy machine info and add if (datItem != null) { datItem.CopyMachineInformation(machine); datItem.Source = new Source { Index = indexId, Name = filename }; ParseAddHelper(datItem); } } /// /// Create and open an output file for writing direct from a dictionary /// /// Name of the file to write to /// True if blank roms should be skipped on output, false otherwise (default) /// True if the error that is thrown should be thrown back to the caller, false otherwise /// True if the DAT was written correctly, false otherwise public override bool WriteToFile(string outfile, bool ignoreblanks = false, bool throwOnError = false) { try { logger.User($"Opening file for writing: {outfile}"); FileStream fs = File.Create(outfile); // If we get back null for some reason, just log and return if (fs == null) { logger.Warning($"File '{outfile}' could not be created for writing! Please check to see if the file is writable"); return false; } StreamWriter sw = new StreamWriter(fs, new UTF8Encoding(false)); JsonTextWriter jtw = new JsonTextWriter(sw) { Formatting = Formatting.Indented, IndentChar = '\t', Indentation = 1 }; // Write out the header WriteHeader(jtw); // 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) { List 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(jtw); // If we have a new game, output the beginning of the new item if (lastgame == null || lastgame.ToLowerInvariant() != datItem.Machine.Name.ToLowerInvariant()) WriteStartGame(jtw, datItem); // Check for a "null" item datItem = ProcessNullifiedItem(datItem); // Write out the item if we're not ignoring if (!ShouldIgnore(datItem, ignoreblanks)) WriteDatItem(jtw, datItem); // Set the new data to compare against lastgame = datItem.Machine.Name; } } // Write the file footer out WriteFooter(jtw); logger.Verbose("File written!" + Environment.NewLine); jtw.Close(); fs.Dispose(); } catch (Exception ex) { logger.Error(ex); if (throwOnError) throw ex; return false; } return true; } /// /// Write out DAT header using the supplied JsonTextWriter /// /// JsonTextWriter to output to private void WriteHeader(JsonTextWriter jtw) { jtw.WriteStartObject(); // Write the DatHeader jtw.WritePropertyName("header"); JsonSerializer js = new JsonSerializer() { Formatting = Formatting.Indented }; js.Serialize(jtw, Header); jtw.WritePropertyName("machines"); jtw.WriteStartArray(); jtw.Flush(); } /// /// Write out Game start using the supplied JsonTextWriter /// /// JsonTextWriter to output to /// DatItem object to be output private void WriteStartGame(JsonTextWriter jtw, DatItem datItem) { // No game should start with a path separator datItem.Machine.Name = datItem.Machine.Name.TrimStart(Path.DirectorySeparatorChar) ?? string.Empty; // Build the state jtw.WriteStartObject(); // Write the Machine jtw.WritePropertyName("machine"); JsonSerializer js = new JsonSerializer() { Formatting = Formatting.Indented }; js.Serialize(jtw, datItem.Machine); jtw.WritePropertyName("items"); jtw.WriteStartArray(); jtw.Flush(); } /// /// Write out Game end using the supplied JsonTextWriter /// /// JsonTextWriter to output to private void WriteEndGame(JsonTextWriter jtw) { // End items jtw.WriteEndArray(); // End machine jtw.WriteEndObject(); jtw.Flush(); } /// /// Write out DatItem using the supplied JsonTextWriter /// /// JsonTextWriter to output to /// DatItem object to be output private void WriteDatItem(JsonTextWriter jtw, DatItem datItem) { // Pre-process the item name ProcessItemName(datItem, true); // Build the state jtw.WriteStartObject(); // Write the DatItem jtw.WritePropertyName("datitem"); JsonSerializer js = new JsonSerializer() { ContractResolver = new BaseFirstContractResolver(), Formatting = Formatting.Indented }; js.Serialize(jtw, datItem); // End item jtw.WriteEndObject(); jtw.Flush(); } /// /// Write out DAT footer using the supplied JsonTextWriter /// /// JsonTextWriter to output to private void WriteFooter(JsonTextWriter jtw) { // End items jtw.WriteEndArray(); // End machine jtw.WriteEndObject(); // End machines jtw.WriteEndArray(); // End file jtw.WriteEndObject(); jtw.Flush(); } // https://github.com/dotnet/runtime/issues/728 private class BaseFirstContractResolver : DefaultContractResolver { public BaseFirstContractResolver() { NamingStrategy = new CamelCaseNamingStrategy(); } protected override IList CreateProperties(Type type, MemberSerialization memberSerialization) { return base.CreateProperties(type, memberSerialization) .OrderBy(p => BaseTypesAndSelf(p.DeclaringType).Count()).ToList(); IEnumerable BaseTypesAndSelf(Type t) { while (t != null) { yield return t; t = t.BaseType; } } } } } }