diff --git a/README.MD b/README.MD index 524478ba..e7192066 100644 --- a/README.MD +++ b/README.MD @@ -11,6 +11,7 @@ Below is a table representing the various interfaces that are implemented within | Interface Name | Source Type | Destination Type | | --- | --- | --- | | `IByteDeserializer` | `byte[]?` | Model | +| `IByteSerializer` | Model | `byte[]?` | | `IFileDeserializer` | `string?` path | Model | | `IFileSerializer` | Model | `string?` path | | `IModelSerializer` | Model | Model | diff --git a/SabreTools.Serialization/Deserializers/AACS.cs b/SabreTools.Serialization/Deserializers/AACS.cs index 7ac4b721..06aff2eb 100644 --- a/SabreTools.Serialization/Deserializers/AACS.cs +++ b/SabreTools.Serialization/Deserializers/AACS.cs @@ -4,71 +4,13 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.AACS; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class AACS : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class AACS : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static MediaKeyBlock? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new AACS(); - return deserializer.Deserialize(data, offset); - } - /// - public MediaKeyBlock? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static MediaKeyBlock? DeserializeFile(string? path) - { - var deserializer = new AACS(); - return deserializer.Deserialize(path); - } - - /// - public MediaKeyBlock? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static MediaKeyBlock? DeserializeStream(Stream? data) - { - var deserializer = new AACS(); - return deserializer.Deserialize(data); - } - - /// - public MediaKeyBlock? Deserialize(Stream? data) + public override MediaKeyBlock? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -496,7 +438,5 @@ namespace SabreTools.Serialization.Deserializers return record; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/ArchiveDotOrg.cs b/SabreTools.Serialization/Deserializers/ArchiveDotOrg.cs index acedfcb6..fddb3784 100644 --- a/SabreTools.Serialization/Deserializers/ArchiveDotOrg.cs +++ b/SabreTools.Serialization/Deserializers/ArchiveDotOrg.cs @@ -1,39 +1,7 @@ namespace SabreTools.Serialization.Deserializers { - public class ArchiveDotOrg : - XmlFile + public class ArchiveDotOrg : XmlFile { - #region IByteDeserializer - - /// - public static Models.ArchiveDotOrg.Files? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new ArchiveDotOrg(); - return deserializer.Deserialize(data, offset); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.ArchiveDotOrg.Files? DeserializeFile(string? path) - { - var deserializer = new ArchiveDotOrg(); - return deserializer.Deserialize(path); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.ArchiveDotOrg.Files? DeserializeStream(System.IO.Stream? data) - { - var deserializer = new ArchiveDotOrg(); - return deserializer.Deserialize(data); - } - - #endregion + // All logic taken care of in the base class } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/AttractMode.cs b/SabreTools.Serialization/Deserializers/AttractMode.cs index 4b852b0a..dda66bf6 100644 --- a/SabreTools.Serialization/Deserializers/AttractMode.cs +++ b/SabreTools.Serialization/Deserializers/AttractMode.cs @@ -4,14 +4,10 @@ using System.Linq; using System.Text; using SabreTools.IO.Readers; using SabreTools.Models.AttractMode; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class AttractMode : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class AttractMode : BaseBinaryDeserializer { #region Constants @@ -21,62 +17,10 @@ namespace SabreTools.Serialization.Deserializers #endregion - #region IByteDeserializer - - /// - public static MetadataFile? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new AttractMode(); - return deserializer.Deserialize(data, offset); - } - - /// - public MetadataFile? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static MetadataFile? DeserializeFile(string? path) - { - var deserializer = new AttractMode(); - return deserializer.Deserialize(path); - } - - /// - public MetadataFile? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - #region IStreamDeserializer - /// - public static MetadataFile? DeserializeStream(Stream? data) - { - var deserializer = new AttractMode(); - return deserializer.Deserialize(data); - } - /// - public MetadataFile? Deserialize(Stream? data) + public override MetadataFile? Deserialize(Stream? data) { // If the stream is null if (data == null) diff --git a/SabreTools.Serialization/Deserializers/BDPlus.cs b/SabreTools.Serialization/Deserializers/BDPlus.cs index 1fa34bd6..1d4f7ce3 100644 --- a/SabreTools.Serialization/Deserializers/BDPlus.cs +++ b/SabreTools.Serialization/Deserializers/BDPlus.cs @@ -2,72 +2,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.BDPlus; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.BDPlus.Constants; namespace SabreTools.Serialization.Deserializers { - public class BDPlus : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class BDPlus : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static SVM? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new BDPlus(); - return deserializer.Deserialize(data, offset); - } - /// - public SVM? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static SVM? DeserializeFile(string? path) - { - var deserializer = new BDPlus(); - return deserializer.Deserialize(path); - } - - /// - public SVM? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static SVM? DeserializeStream(Stream? data) - { - var deserializer = new BDPlus(); - return deserializer.Deserialize(data); - } - - /// - public SVM? Deserialize(Stream? data) + public override SVM? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -119,7 +61,5 @@ namespace SabreTools.Serialization.Deserializers return svm; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/BFPK.cs b/SabreTools.Serialization/Deserializers/BFPK.cs index ea1bbb3c..080a48aa 100644 --- a/SabreTools.Serialization/Deserializers/BFPK.cs +++ b/SabreTools.Serialization/Deserializers/BFPK.cs @@ -2,72 +2,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.BFPK; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.BFPK.Constants; namespace SabreTools.Serialization.Deserializers { - public class BFPK : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class BFPK : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Archive? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new BFPK(); - return deserializer.Deserialize(data, offset); - } - /// - public Archive? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Archive? DeserializeFile(string? path) - { - var deserializer = new BFPK(); - return deserializer.Deserialize(path); - } - - /// - public Archive? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Archive? DeserializeStream(Stream? data) - { - var deserializer = new BFPK(); - return deserializer.Deserialize(data); - } - - /// - public Archive? Deserialize(Stream? data) + public override Archive? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -175,7 +117,5 @@ namespace SabreTools.Serialization.Deserializers return fileEntry; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/BSP.cs b/SabreTools.Serialization/Deserializers/BSP.cs index 2d56c89d..e69acd66 100644 --- a/SabreTools.Serialization/Deserializers/BSP.cs +++ b/SabreTools.Serialization/Deserializers/BSP.cs @@ -3,72 +3,14 @@ using System.Linq; using System.Text; using SabreTools.IO; using SabreTools.Models.BSP; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.BSP.Constants; namespace SabreTools.Serialization.Deserializers { - public class BSP : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class BSP : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.BSP.File? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new BSP(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.BSP.File? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.BSP.File? DeserializeFile(string? path) - { - var deserializer = new BSP(); - return deserializer.Deserialize(path); - } - - /// - public Models.BSP.File? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.BSP.File? DeserializeStream(Stream? data) - { - var deserializer = new BSP(); - return deserializer.Deserialize(data); - } - - /// - public Models.BSP.File? Deserialize(Stream? data) + public override Models.BSP.File? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -274,7 +216,5 @@ namespace SabreTools.Serialization.Deserializers return texture; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/BaseBinaryDeserializer.cs b/SabreTools.Serialization/Deserializers/BaseBinaryDeserializer.cs new file mode 100644 index 00000000..610040a5 --- /dev/null +++ b/SabreTools.Serialization/Deserializers/BaseBinaryDeserializer.cs @@ -0,0 +1,134 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Reflection; +using SabreTools.Serialization.Interfaces; + +namespace SabreTools.Serialization.Deserializers +{ + /// + /// Base class for all binary deserializers + /// + /// Type of the model to deserialize + /// These methods assume there is a concrete implementation of the deserialzier for the model available + public abstract class BaseBinaryDeserializer : + IByteDeserializer, + IFileDeserializer, + IStreamDeserializer + { + #region IByteDeserializer + + /// + public virtual TModel? Deserialize(byte[]? data, int offset) + { + // If the data is invalid + if (data == null) + 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 DeserializeStream(dataStream); + } + + #endregion + + #region IFileDeserializer + + /// + public virtual TModel? Deserialize(string? path) + { + using var stream = PathProcessor.OpenStream(path); + return DeserializeStream(stream); + } + + #endregion + + #region IStreamDeserializer + + /// + public abstract TModel? Deserialize(Stream? data); + + #endregion + + #region Static Implementations + + /// + public static TModel? DeserializeBytes(byte[]? data, int offset) + { + var deserializer = GetType>(); + if (deserializer == null) + return default; + + return deserializer.Deserialize(data, offset); + } + + /// + public static TModel? DeserializeFile(string? path) + { + var deserializer = GetType>(); + if (deserializer == null) + return default; + + return deserializer.Deserialize(path); + } + + /// + public static TModel? DeserializeStream(Stream? data) + { + var deserializer = GetType>(); + if (deserializer == null) + return default; + + return deserializer.Deserialize(data); + } + + #endregion + + #region Helpers + + /// + /// Get a constructed instance of a type, if possible + /// + /// Deserializer type to construct + /// Deserializer of the requested type, null on error + private static TDeserializer? GetType() + { + var assembly = Assembly.GetExecutingAssembly(); + if (assembly == null) + return default; + + // If not all types can be loaded, use the ones that could be + List assemblyTypes = []; + try + { + assemblyTypes = assembly.GetTypes().ToList(); + } + catch (ReflectionTypeLoadException rtle) + { + assemblyTypes = rtle.Types.Where(t => t != null)!.ToList(); + } + + // Loop through all types + foreach (Type type in assemblyTypes) + { + // If the type isn't a class or doesn't implement the interface + if (!type.IsClass || type.GetInterface(typeof(TDeserializer).Name) == null) + continue; + + // Try to create a concrete instance of the type + var instance = (TDeserializer?)Activator.CreateInstance(type); + if (instance != null) + return instance; + } + + return default; + } + + #endregion + } +} \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/CFB.cs b/SabreTools.Serialization/Deserializers/CFB.cs index fc3e6674..9abbff25 100644 --- a/SabreTools.Serialization/Deserializers/CFB.cs +++ b/SabreTools.Serialization/Deserializers/CFB.cs @@ -4,72 +4,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.CFB; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.CFB.Constants; namespace SabreTools.Serialization.Deserializers { - public class CFB : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class CFB : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Binary? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new CFB(); - return deserializer.Deserialize(data, offset); - } - /// - public Binary? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Binary? DeserializeFile(string? path) - { - var deserializer = new CFB(); - return deserializer.Deserialize(path); - } - - /// - public Binary? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Binary? DeserializeStream(Stream? data) - { - var deserializer = new CFB(); - return deserializer.Deserialize(data); - } - - /// - public Binary? Deserialize(Stream? data) + public override Binary? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -418,7 +360,5 @@ namespace SabreTools.Serialization.Deserializers return directoryEntry; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/CIA.cs b/SabreTools.Serialization/Deserializers/CIA.cs index d08c549c..5d4277da 100644 --- a/SabreTools.Serialization/Deserializers/CIA.cs +++ b/SabreTools.Serialization/Deserializers/CIA.cs @@ -3,71 +3,13 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.N3DS; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class CIA : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class CIA : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.N3DS.CIA? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new CIA(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.N3DS.CIA? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.N3DS.CIA? DeserializeFile(string? path) - { - var deserializer = new CIA(); - return deserializer.Deserialize(path); - } - - /// - public Models.N3DS.CIA? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.N3DS.CIA? DeserializeStream(Stream? data) - { - var deserializer = new CIA(); - return deserializer.Deserialize(data); - } - - /// - public Models.N3DS.CIA? Deserialize(Stream? data) + public override Models.N3DS.CIA? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -557,7 +499,5 @@ namespace SabreTools.Serialization.Deserializers return metaData; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/Catalog.cs b/SabreTools.Serialization/Deserializers/Catalog.cs index 481c9d92..750f5df9 100644 --- a/SabreTools.Serialization/Deserializers/Catalog.cs +++ b/SabreTools.Serialization/Deserializers/Catalog.cs @@ -3,18 +3,10 @@ using System.Text; namespace SabreTools.Serialization.Deserializers { - public class Catalog : - JsonFile + public class Catalog : JsonFile { #region IByteDeserializer - /// - public static Models.Xbox.Catalog? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new Catalog(); - return deserializer.Deserialize(data, offset); - } - /// Catalog.js file is encoded as UTF-16 LE public override Models.Xbox.Catalog? Deserialize(byte[]? data, int offset) => Deserialize(data, offset, new UnicodeEncoding()); @@ -23,13 +15,6 @@ namespace SabreTools.Serialization.Deserializers #region IFileDeserializer - /// - public static Models.Xbox.Catalog? DeserializeFile(string? path) - { - var deserializer = new Catalog(); - return deserializer.Deserialize(path); - } - /// Catalog.js file is encoded as UTF-16 LE public override Models.Xbox.Catalog? Deserialize(string? path) => Deserialize(path, new UnicodeEncoding()); @@ -38,13 +23,6 @@ namespace SabreTools.Serialization.Deserializers #region IStreamDeserializer - /// - public static Models.Xbox.Catalog? DeserializeStream(Stream? data) - { - var deserializer = new Catalog(); - return deserializer.Deserialize(data); - } - /// Catalog.js file is encoded as UTF-16 LE public override Models.Xbox.Catalog? Deserialize(Stream? data) => Deserialize(data, new UnicodeEncoding()); diff --git a/SabreTools.Serialization/Deserializers/ClrMamePro.cs b/SabreTools.Serialization/Deserializers/ClrMamePro.cs index 2de58a4c..b5fd1755 100644 --- a/SabreTools.Serialization/Deserializers/ClrMamePro.cs +++ b/SabreTools.Serialization/Deserializers/ClrMamePro.cs @@ -4,14 +4,10 @@ using System.IO; using System.Text; using SabreTools.IO.Readers; using SabreTools.Models.ClrMamePro; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class ClrMamePro : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class ClrMamePro : BaseBinaryDeserializer { #region IByteDeserializer @@ -23,7 +19,7 @@ namespace SabreTools.Serialization.Deserializers } /// - public MetadataFile? Deserialize(byte[]? data, int offset) + public override MetadataFile? Deserialize(byte[]? data, int offset) => Deserialize(data, offset, true); /// @@ -31,11 +27,11 @@ namespace SabreTools.Serialization.Deserializers { // If the data is invalid if (data == null) - return null; + return default; // If the offset is out of bounds if (offset < 0 || offset >= data.Length) - return null; + return default; // Create a memory stream and parse that var dataStream = new MemoryStream(data, offset, data.Length - offset); @@ -54,7 +50,7 @@ namespace SabreTools.Serialization.Deserializers } /// - public MetadataFile? Deserialize(string? path) + public override MetadataFile? Deserialize(string? path) => Deserialize(path, true); /// @@ -76,7 +72,7 @@ namespace SabreTools.Serialization.Deserializers } /// - public MetadataFile? Deserialize(Stream? data) + public override MetadataFile? Deserialize(Stream? data) => Deserialize(data, true); /// diff --git a/SabreTools.Serialization/Deserializers/CueSheet.cs b/SabreTools.Serialization/Deserializers/CueSheet.cs index d77c7f5a..935b9138 100644 --- a/SabreTools.Serialization/Deserializers/CueSheet.cs +++ b/SabreTools.Serialization/Deserializers/CueSheet.cs @@ -5,71 +5,13 @@ using System.Linq; using System.Text.RegularExpressions; using SabreTools.IO; using SabreTools.Models.CueSheets; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class CueSheet : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class CueSheet : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.CueSheets.CueSheet? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new CueSheet(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.CueSheets.CueSheet? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.CueSheets.CueSheet? DeserializeFile(string? path) - { - var deserializer = new CueSheet(); - return deserializer.Deserialize(path); - } - - /// - public Models.CueSheets.CueSheet? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.CueSheets.CueSheet? DeserializeStream(Stream? data) - { - var deserializer = new CueSheet(); - return deserializer.Deserialize(data); - } - - /// - public Models.CueSheets.CueSheet? Deserialize(Stream? data) + public override Models.CueSheets.CueSheet? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -647,7 +589,5 @@ namespace SabreTools.Serialization.Deserializers } #endregion - - #endregion } } diff --git a/SabreTools.Serialization/Deserializers/DosCenter.cs b/SabreTools.Serialization/Deserializers/DosCenter.cs index b6a10eb7..25eac1d2 100644 --- a/SabreTools.Serialization/Deserializers/DosCenter.cs +++ b/SabreTools.Serialization/Deserializers/DosCenter.cs @@ -3,71 +3,13 @@ using System.IO; using System.Text; using SabreTools.IO.Readers; using SabreTools.Models.DosCenter; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class DosCenter : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class DosCenter : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static MetadataFile? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new DosCenter(); - return deserializer.Deserialize(data, offset); - } - /// - public MetadataFile? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static MetadataFile? DeserializeFile(string? path) - { - var deserializer = new DosCenter(); - return deserializer.Deserialize(path); - } - - /// - public MetadataFile? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static MetadataFile? DeserializeStream(Stream? data) - { - var deserializer = new DosCenter(); - return deserializer.Deserialize(data); - } - - /// - public MetadataFile? Deserialize(Stream? data) + public override MetadataFile? Deserialize(Stream? data) { // If the stream is null if (data == null) @@ -268,7 +210,5 @@ namespace SabreTools.Serialization.Deserializers file.ADDITIONAL_ELEMENTS = itemAdditional.ToArray(); return file; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/EverdriveSMDB.cs b/SabreTools.Serialization/Deserializers/EverdriveSMDB.cs index 52c3e4af..3e12c8a7 100644 --- a/SabreTools.Serialization/Deserializers/EverdriveSMDB.cs +++ b/SabreTools.Serialization/Deserializers/EverdriveSMDB.cs @@ -4,71 +4,13 @@ using System.Linq; using System.Text; using SabreTools.IO.Readers; using SabreTools.Models.EverdriveSMDB; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class EverdriveSMDB : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class EverdriveSMDB : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static MetadataFile? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new EverdriveSMDB(); - return deserializer.Deserialize(data, offset); - } - /// - public MetadataFile? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static MetadataFile? DeserializeFile(string? path) - { - var deserializer = new EverdriveSMDB(); - return deserializer.Deserialize(path); - } - - /// - public MetadataFile? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static MetadataFile? DeserializeStream(Stream? data) - { - var deserializer = new EverdriveSMDB(); - return deserializer.Deserialize(data); - } - - /// - public MetadataFile? Deserialize(Stream? data) + public override MetadataFile? Deserialize(Stream? data) { // If the stream is null if (data == null) @@ -116,7 +58,5 @@ namespace SabreTools.Serialization.Deserializers dat.Row = rows.ToArray(); return dat; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/GCF.cs b/SabreTools.Serialization/Deserializers/GCF.cs index 011ab320..1239bd6b 100644 --- a/SabreTools.Serialization/Deserializers/GCF.cs +++ b/SabreTools.Serialization/Deserializers/GCF.cs @@ -3,71 +3,13 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.GCF; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class GCF : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class GCF : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.GCF.File? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new GCF(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.GCF.File? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.GCF.File? DeserializeFile(string? path) - { - var deserializer = new GCF(); - return deserializer.Deserialize(path); - } - - /// - public Models.GCF.File? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.GCF.File? DeserializeStream(Stream? data) - { - var deserializer = new GCF(); - return deserializer.Deserialize(data); - } - - /// - public Models.GCF.File? Deserialize(Stream? data) + public override Models.GCF.File? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -797,7 +739,5 @@ namespace SabreTools.Serialization.Deserializers return dataBlockHeader; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/Hashfile.cs b/SabreTools.Serialization/Deserializers/Hashfile.cs index 503fc038..8f839c4c 100644 --- a/SabreTools.Serialization/Deserializers/Hashfile.cs +++ b/SabreTools.Serialization/Deserializers/Hashfile.cs @@ -4,14 +4,11 @@ using System.IO; using System.Linq; using SabreTools.Hashing; using SabreTools.Models.Hashfile; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class Hashfile : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + // TODO: Create variants for the implemented types + public class Hashfile : BaseBinaryDeserializer { #region IByteDeserializer @@ -23,7 +20,7 @@ namespace SabreTools.Serialization.Deserializers } /// - public Models.Hashfile.Hashfile? Deserialize(byte[]? data, int offset) + public override Models.Hashfile.Hashfile? Deserialize(byte[]? data, int offset) => Deserialize(data, offset, HashType.CRC32); /// @@ -54,7 +51,7 @@ namespace SabreTools.Serialization.Deserializers } /// - public Models.Hashfile.Hashfile? Deserialize(string? path) + public override Models.Hashfile.Hashfile? Deserialize(string? path) => Deserialize(path, HashType.CRC32); /// @@ -76,7 +73,7 @@ namespace SabreTools.Serialization.Deserializers } /// - public Models.Hashfile.Hashfile? Deserialize(Stream? data) + public override Models.Hashfile.Hashfile? Deserialize(Stream? data) => Deserialize(data, HashType.CRC32); /// diff --git a/SabreTools.Serialization/Deserializers/IRD.cs b/SabreTools.Serialization/Deserializers/IRD.cs index c5426b4b..18b225f6 100644 --- a/SabreTools.Serialization/Deserializers/IRD.cs +++ b/SabreTools.Serialization/Deserializers/IRD.cs @@ -1,71 +1,13 @@ using System.IO; using System.Text; using SabreTools.IO; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class IRD : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class IRD : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.IRD.File? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new IRD(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.IRD.File? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.IRD.File? DeserializeFile(string? path) - { - var deserializer = new IRD(); - return deserializer.Deserialize(path); - } - - /// - public Models.IRD.File? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.IRD.File? DeserializeStream(Stream? data) - { - var deserializer = new IRD(); - return deserializer.Deserialize(data); - } - - /// - public Models.IRD.File? Deserialize(Stream? data) + public override Models.IRD.File? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -167,7 +109,5 @@ namespace SabreTools.Serialization.Deserializers return ird; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/InstallShieldCabinet.cs b/SabreTools.Serialization/Deserializers/InstallShieldCabinet.cs index 069a9d8d..a0edb333 100644 --- a/SabreTools.Serialization/Deserializers/InstallShieldCabinet.cs +++ b/SabreTools.Serialization/Deserializers/InstallShieldCabinet.cs @@ -3,73 +3,15 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.InstallShieldCabinet; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.InstallShieldCabinet.Constants; namespace SabreTools.Serialization.Deserializers { // TODO: Add multi-cabinet reading - public class InstallShieldCabinet : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class InstallShieldCabinet : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Cabinet? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new InstallShieldCabinet(); - return deserializer.Deserialize(data, offset); - } - /// - public Cabinet? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Cabinet? DeserializeFile(string? path) - { - var deserializer = new InstallShieldCabinet(); - return deserializer.Deserialize(path); - } - - /// - public Cabinet? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Cabinet? DeserializeStream(Stream? data) - { - var deserializer = new InstallShieldCabinet(); - return deserializer.Deserialize(data); - } - - /// - public Cabinet? Deserialize(Stream? data) + public override Cabinet? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -833,7 +775,5 @@ namespace SabreTools.Serialization.Deserializers } #endregion - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/JsonFile.cs b/SabreTools.Serialization/Deserializers/JsonFile.cs index 5683d6b6..c88efd96 100644 --- a/SabreTools.Serialization/Deserializers/JsonFile.cs +++ b/SabreTools.Serialization/Deserializers/JsonFile.cs @@ -1,7 +1,6 @@ using System.IO; using System.Text; using Newtonsoft.Json; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { @@ -9,15 +8,12 @@ namespace SabreTools.Serialization.Deserializers /// Base class for other JSON serializers /// /// - public class JsonFile : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class JsonFile : BaseBinaryDeserializer { #region IByteDeserializer /// - public virtual T? Deserialize(byte[]? data, int offset) + public override T? Deserialize(byte[]? data, int offset) => Deserialize(data, offset, new UTF8Encoding(false)); /// @@ -48,7 +44,7 @@ namespace SabreTools.Serialization.Deserializers #region IFileDeserializer /// - public virtual T? Deserialize(string? path) + public override T? Deserialize(string? path) => Deserialize(path, new UTF8Encoding(false)); /// @@ -69,7 +65,7 @@ namespace SabreTools.Serialization.Deserializers #region IStreamDeserializer /// - public virtual T? Deserialize(Stream? data) + public override T? Deserialize(Stream? data) => Deserialize(data, new UTF8Encoding(false)); /// diff --git a/SabreTools.Serialization/Deserializers/LinearExecutable.cs b/SabreTools.Serialization/Deserializers/LinearExecutable.cs index 78e18246..5ebb74a8 100644 --- a/SabreTools.Serialization/Deserializers/LinearExecutable.cs +++ b/SabreTools.Serialization/Deserializers/LinearExecutable.cs @@ -3,72 +3,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.LinearExecutable; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.LinearExecutable.Constants; namespace SabreTools.Serialization.Deserializers { - public class LinearExecutable : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class LinearExecutable : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Executable? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new LinearExecutable(); - return deserializer.Deserialize(data, offset); - } - /// - public Executable? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Executable? DeserializeFile(string? path) - { - var deserializer = new LinearExecutable(); - return deserializer.Deserialize(path); - } - - /// - public Executable? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Executable? DeserializeStream(Stream? data) - { - var deserializer = new LinearExecutable(); - return deserializer.Deserialize(data); - } - - /// - public Executable? Deserialize(Stream? data) + public override Executable? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -1059,7 +1001,5 @@ namespace SabreTools.Serialization.Deserializers return debugInformation; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/Listrom.cs b/SabreTools.Serialization/Deserializers/Listrom.cs index 6bc87733..52c0b72d 100644 --- a/SabreTools.Serialization/Deserializers/Listrom.cs +++ b/SabreTools.Serialization/Deserializers/Listrom.cs @@ -3,71 +3,13 @@ using System.Collections.Generic; using System.IO; using System.Text; using SabreTools.Models.Listrom; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class Listrom : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class Listrom : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static MetadataFile? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new Listrom(); - return deserializer.Deserialize(data, offset); - } - /// - public MetadataFile? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static MetadataFile? DeserializeFile(string? path) - { - var deserializer = new Listrom(); - return deserializer.Deserialize(path); - } - - /// - public MetadataFile? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static MetadataFile? DeserializeStream(Stream? data) - { - var deserializer = new Listrom(); - return deserializer.Deserialize(data); - } - - /// - public MetadataFile? Deserialize(Stream? data) + public override MetadataFile? Deserialize(Stream? data) { // If the stream is null if (data == null) @@ -295,7 +237,5 @@ namespace SabreTools.Serialization.Deserializers dat.ADDITIONAL_ELEMENTS = additional.ToArray(); return dat; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/Listxml.cs b/SabreTools.Serialization/Deserializers/Listxml.cs index 6b0c3611..cb984858 100644 --- a/SabreTools.Serialization/Deserializers/Listxml.cs +++ b/SabreTools.Serialization/Deserializers/Listxml.cs @@ -1,39 +1,7 @@ namespace SabreTools.Serialization.Deserializers { - public class Listxml : - XmlFile + public class Listxml : XmlFile { - #region IByteDeserializer - - /// - public static Models.Listxml.Mame? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new Listxml(); - return deserializer.Deserialize(data, offset); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.Listxml.Mame? DeserializeFile(string? path) - { - var deserializer = new Listxml(); - return deserializer.Deserialize(path); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.Listxml.Mame? DeserializeStream(System.IO.Stream? data) - { - var deserializer = new Listxml(); - return deserializer.Deserialize(data); - } - - #endregion + // All logic taken care of in the base class } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/Logiqx.cs b/SabreTools.Serialization/Deserializers/Logiqx.cs index 71849c4e..aee13e85 100644 --- a/SabreTools.Serialization/Deserializers/Logiqx.cs +++ b/SabreTools.Serialization/Deserializers/Logiqx.cs @@ -1,39 +1,7 @@ namespace SabreTools.Serialization.Deserializers { - public class Logiqx : - XmlFile + public class Logiqx : XmlFile { - #region IByteDeserializer - - /// - public static Models.Logiqx.Datafile? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new Logiqx(); - return deserializer.Deserialize(data, offset); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.Logiqx.Datafile? DeserializeFile(string? path) - { - var deserializer = new Logiqx(); - return deserializer.Deserialize(path); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.Logiqx.Datafile? DeserializeStream(System.IO.Stream? data) - { - var deserializer = new Logiqx(); - return deserializer.Deserialize(data); - } - - #endregion + // All logic taken care of in the base class } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/M1.cs b/SabreTools.Serialization/Deserializers/M1.cs index c7d8e3e0..7cb5440d 100644 --- a/SabreTools.Serialization/Deserializers/M1.cs +++ b/SabreTools.Serialization/Deserializers/M1.cs @@ -1,39 +1,7 @@ namespace SabreTools.Serialization.Deserializers { - public class M1 : - XmlFile + public class M1 : XmlFile { - #region IByteDeserializer - - /// - public static Models.Listxml.M1? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new M1(); - return deserializer.Deserialize(data, offset); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.Listxml.M1? DeserializeFile(string? path) - { - var deserializer = new M1(); - return deserializer.Deserialize(path); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.Listxml.M1? DeserializeStream(System.IO.Stream? data) - { - var deserializer = new M1(); - return deserializer.Deserialize(data); - } - - #endregion + // All logic taken care of in the base class } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/MSDOS.cs b/SabreTools.Serialization/Deserializers/MSDOS.cs index 6a8d4815..b0f3374e 100644 --- a/SabreTools.Serialization/Deserializers/MSDOS.cs +++ b/SabreTools.Serialization/Deserializers/MSDOS.cs @@ -2,72 +2,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.MSDOS; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.MSDOS.Constants; namespace SabreTools.Serialization.Deserializers { - public class MSDOS : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class MSDOS : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Executable? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new MSDOS(); - return deserializer.Deserialize(data, offset); - } - /// - public Executable? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Executable? DeserializeFile(string? path) - { - var deserializer = new MSDOS(); - return deserializer.Deserialize(path); - } - - /// - public Executable? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Executable? DeserializeStream(Stream? data) - { - var deserializer = new MSDOS(); - return deserializer.Deserialize(data); - } - - /// - public Executable? Deserialize(Stream? data) + public override Executable? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -199,7 +141,5 @@ namespace SabreTools.Serialization.Deserializers return relocationTable; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/MicrosoftCabinet.cs b/SabreTools.Serialization/Deserializers/MicrosoftCabinet.cs index 4e58a589..e35b5647 100644 --- a/SabreTools.Serialization/Deserializers/MicrosoftCabinet.cs +++ b/SabreTools.Serialization/Deserializers/MicrosoftCabinet.cs @@ -2,73 +2,15 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.MicrosoftCabinet; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.MicrosoftCabinet.Constants; namespace SabreTools.Serialization.Deserializers { // TODO: Add multi-cabinet reading - public class MicrosoftCabinet : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class MicrosoftCabinet : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Cabinet? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new MicrosoftCabinet(); - return deserializer.Deserialize(data, offset); - } - /// - public Cabinet? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Cabinet? DeserializeFile(string? path) - { - var deserializer = new MicrosoftCabinet(); - return deserializer.Deserialize(path); - } - - /// - public Cabinet? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Cabinet? DeserializeStream(Stream? data) - { - var deserializer = new MicrosoftCabinet(); - return deserializer.Deserialize(data); - } - - /// - public Cabinet? Deserialize(Stream? data) + public override Cabinet? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -298,7 +240,5 @@ namespace SabreTools.Serialization.Deserializers return file; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/MoPaQ.cs b/SabreTools.Serialization/Deserializers/MoPaQ.cs index 286e06b4..0d947829 100644 --- a/SabreTools.Serialization/Deserializers/MoPaQ.cs +++ b/SabreTools.Serialization/Deserializers/MoPaQ.cs @@ -4,72 +4,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.MoPaQ; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.MoPaQ.Constants; namespace SabreTools.Serialization.Deserializers { - public class MoPaQ : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class MoPaQ : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Archive? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new MoPaQ(); - return deserializer.Deserialize(data, offset); - } - /// - public Archive? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Archive? DeserializeFile(string? path) - { - var deserializer = new MoPaQ(); - return deserializer.Deserialize(path); - } - - /// - public Archive? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Archive? DeserializeStream(Stream? data) - { - var deserializer = new MoPaQ(); - return deserializer.Deserialize(data); - } - - /// - public Archive? Deserialize(Stream? data) + public override Archive? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -685,7 +627,5 @@ namespace SabreTools.Serialization.Deserializers } #endregion - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/N3DS.cs b/SabreTools.Serialization/Deserializers/N3DS.cs index 09a8a915..a64a553d 100644 --- a/SabreTools.Serialization/Deserializers/N3DS.cs +++ b/SabreTools.Serialization/Deserializers/N3DS.cs @@ -3,72 +3,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.N3DS; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.N3DS.Constants; namespace SabreTools.Serialization.Deserializers { - public class N3DS : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class N3DS : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Cart? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new N3DS(); - return deserializer.Deserialize(data, offset); - } - /// - public Cart? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Cart? DeserializeFile(string? path) - { - var deserializer = new N3DS(); - return deserializer.Deserialize(path); - } - - /// - public Cart? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Cart? DeserializeStream(Stream? data) - { - var deserializer = new N3DS(); - return deserializer.Deserialize(data); - } - - /// - public Cart? Deserialize(Stream? data) + public override Cart? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -765,7 +707,5 @@ namespace SabreTools.Serialization.Deserializers return romFSHeader; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/NCF.cs b/SabreTools.Serialization/Deserializers/NCF.cs index d3aa0a90..e3c7d629 100644 --- a/SabreTools.Serialization/Deserializers/NCF.cs +++ b/SabreTools.Serialization/Deserializers/NCF.cs @@ -3,71 +3,13 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.NCF; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class NCF : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class NCF : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.NCF.File? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new NCF(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.NCF.File? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.NCF.File? DeserializeFile(string? path) - { - var deserializer = new NCF(); - return deserializer.Deserialize(path); - } - - /// - public Models.NCF.File? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.NCF.File? DeserializeStream(Stream? data) - { - var deserializer = new NCF(); - return deserializer.Deserialize(data); - } - - /// - public Models.NCF.File? Deserialize(Stream? data) + public override Models.NCF.File? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -566,7 +508,5 @@ namespace SabreTools.Serialization.Deserializers return checksumEntry; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/NewExecutable.cs b/SabreTools.Serialization/Deserializers/NewExecutable.cs index acb89e57..ac8810b4 100644 --- a/SabreTools.Serialization/Deserializers/NewExecutable.cs +++ b/SabreTools.Serialization/Deserializers/NewExecutable.cs @@ -4,72 +4,14 @@ using System.Linq; using System.Text; using SabreTools.IO; using SabreTools.Models.NewExecutable; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.NewExecutable.Constants; namespace SabreTools.Serialization.Deserializers { - public class NewExecutable : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class NewExecutable : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Executable? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new NewExecutable(); - return deserializer.Deserialize(data, offset); - } - /// - public Executable? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Executable? DeserializeFile(string? path) - { - var deserializer = new NewExecutable(); - return deserializer.Deserialize(path); - } - - /// - public Executable? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Executable? DeserializeStream(Stream? data) - { - var deserializer = new NewExecutable(); - return deserializer.Deserialize(data); - } - - /// - public Executable? Deserialize(Stream? data) + public override Executable? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -534,7 +476,5 @@ namespace SabreTools.Serialization.Deserializers return [.. residentNameTable]; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/Nitro.cs b/SabreTools.Serialization/Deserializers/Nitro.cs index 3ccca111..e09ade2c 100644 --- a/SabreTools.Serialization/Deserializers/Nitro.cs +++ b/SabreTools.Serialization/Deserializers/Nitro.cs @@ -3,71 +3,13 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.Nitro; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class Nitro : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class Nitro : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Cart? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new Nitro(); - return deserializer.Deserialize(data, offset); - } - /// - public Cart? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Cart? DeserializeFile(string? path) - { - var deserializer = new Nitro(); - return deserializer.Deserialize(path); - } - - /// - public Cart? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Cart? DeserializeStream(Stream? data) - { - var deserializer = new Nitro(); - return deserializer.Deserialize(data); - } - - /// - public Cart? Deserialize(Stream? data) + public override Cart? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -417,7 +359,5 @@ namespace SabreTools.Serialization.Deserializers return entry; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/OfflineList.cs b/SabreTools.Serialization/Deserializers/OfflineList.cs index 5ee37f43..bcd208ad 100644 --- a/SabreTools.Serialization/Deserializers/OfflineList.cs +++ b/SabreTools.Serialization/Deserializers/OfflineList.cs @@ -1,39 +1,7 @@ namespace SabreTools.Serialization.Deserializers { - public class OfflineList : - XmlFile + public class OfflineList : XmlFile { - #region IByteDeserializer - - /// - public static Models.OfflineList.Dat? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new OfflineList(); - return deserializer.Deserialize(data, offset); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.OfflineList.Dat? DeserializeFile(string? path) - { - var deserializer = new OfflineList(); - return deserializer.Deserialize(path); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.OfflineList.Dat? DeserializeStream(System.IO.Stream? data) - { - var deserializer = new OfflineList(); - return deserializer.Deserialize(data); - } - - #endregion + // All logic taken care of in the base class } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/OpenMSX.cs b/SabreTools.Serialization/Deserializers/OpenMSX.cs index c0d454a8..2b84c0b7 100644 --- a/SabreTools.Serialization/Deserializers/OpenMSX.cs +++ b/SabreTools.Serialization/Deserializers/OpenMSX.cs @@ -1,39 +1,7 @@ namespace SabreTools.Serialization.Deserializers { - public class OpenMSX : - XmlFile + public class OpenMSX : XmlFile { - #region IByteDeserializer - - /// - public static Models.OpenMSX.SoftwareDb? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new OpenMSX(); - return deserializer.Deserialize(data, offset); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.OpenMSX.SoftwareDb? DeserializeFile(string? path) - { - var deserializer = new OpenMSX(); - return deserializer.Deserialize(path); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.OpenMSX.SoftwareDb? DeserializeStream(System.IO.Stream? data) - { - var deserializer = new OpenMSX(); - return deserializer.Deserialize(data); - } - - #endregion + // All logic taken care of in the base class } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/PAK.cs b/SabreTools.Serialization/Deserializers/PAK.cs index f997e25f..c5ceb2d5 100644 --- a/SabreTools.Serialization/Deserializers/PAK.cs +++ b/SabreTools.Serialization/Deserializers/PAK.cs @@ -2,72 +2,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.PAK; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.PAK.Constants; namespace SabreTools.Serialization.Deserializers { - public class PAK : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class PAK : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.PAK.File? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new PAK(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.PAK.File? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.PAK.File? DeserializeFile(string? path) - { - var deserializer = new PAK(); - return deserializer.Deserialize(path); - } - - /// - public Models.PAK.File? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.PAK.File? DeserializeStream(Stream? data) - { - var deserializer = new PAK(); - return deserializer.Deserialize(data); - } - - /// - public Models.PAK.File? Deserialize(Stream? data) + public override Models.PAK.File? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -162,7 +104,5 @@ namespace SabreTools.Serialization.Deserializers return directoryItem; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/PFF.cs b/SabreTools.Serialization/Deserializers/PFF.cs index 3857d8cc..52ca2f3a 100644 --- a/SabreTools.Serialization/Deserializers/PFF.cs +++ b/SabreTools.Serialization/Deserializers/PFF.cs @@ -2,72 +2,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.PFF; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.PFF.Constants; namespace SabreTools.Serialization.Deserializers { - public class PFF : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class PFF : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Archive? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new PFF(); - return deserializer.Deserialize(data, offset); - } - /// - public Archive? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Archive? DeserializeFile(string? path) - { - var deserializer = new PFF(); - return deserializer.Deserialize(path); - } - - /// - public Archive? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Archive? DeserializeStream(Stream? data) - { - var deserializer = new PFF(); - return deserializer.Deserialize(data); - } - - /// - public Archive? Deserialize(Stream? data) + public override Archive? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -237,7 +179,5 @@ namespace SabreTools.Serialization.Deserializers return segment; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/PIC.cs b/SabreTools.Serialization/Deserializers/PIC.cs index d90a6aaa..2fa5e6ac 100644 --- a/SabreTools.Serialization/Deserializers/PIC.cs +++ b/SabreTools.Serialization/Deserializers/PIC.cs @@ -3,72 +3,16 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.PIC; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.PIC.Constants; namespace SabreTools.Serialization.Deserializers { - public class PIC : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class PIC : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static DiscInformation? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new PIC(); - return deserializer.Deserialize(data, offset); - } - - /// - public DiscInformation? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static DiscInformation? DeserializeFile(string? path) - { - var deserializer = new PIC(); - return deserializer.Deserialize(path); - } - - /// - public DiscInformation? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - #region IStreamDeserializer - /// - public static DiscInformation? DeserializeStream(Stream? data) - { - var deserializer = new PIC(); - return deserializer.Deserialize(data); - } - /// - public DiscInformation? Deserialize(Stream? data) + public override DiscInformation? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) diff --git a/SabreTools.Serialization/Deserializers/PlayJAudio.cs b/SabreTools.Serialization/Deserializers/PlayJAudio.cs index ba036b36..bd08254d 100644 --- a/SabreTools.Serialization/Deserializers/PlayJAudio.cs +++ b/SabreTools.Serialization/Deserializers/PlayJAudio.cs @@ -2,63 +2,12 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.PlayJ; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.PlayJ.Constants; namespace SabreTools.Serialization.Deserializers { - public class PlayJAudio : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class PlayJAudio : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static AudioFile? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new PlayJAudio(); - return deserializer.Deserialize(data, offset); - } - - /// - public AudioFile? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static AudioFile? DeserializeFile(string? path) - { - var deserializer = new PlayJAudio(); - return deserializer.Deserialize(path); - } - - /// - public AudioFile? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - /// public static AudioFile? DeserializeStream(Stream? data, long adjust = 0) { @@ -67,7 +16,7 @@ namespace SabreTools.Serialization.Deserializers } /// - public AudioFile? Deserialize(Stream? data) + public override AudioFile? Deserialize(Stream? data) => Deserialize(data, 0); /// @@ -397,7 +346,5 @@ namespace SabreTools.Serialization.Deserializers return dataFile; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/PlayJPlaylist.cs b/SabreTools.Serialization/Deserializers/PlayJPlaylist.cs index 2db03e7e..c5cbfce0 100644 --- a/SabreTools.Serialization/Deserializers/PlayJPlaylist.cs +++ b/SabreTools.Serialization/Deserializers/PlayJPlaylist.cs @@ -1,71 +1,13 @@ using System.IO; using SabreTools.IO; using SabreTools.Models.PlayJ; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class PlayJPlaylist : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class PlayJPlaylist : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Playlist? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new PlayJPlaylist(); - return deserializer.Deserialize(data, offset); - } - /// - public Playlist? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Playlist? DeserializeFile(string? path) - { - var deserializer = new PlayJPlaylist(); - return deserializer.Deserialize(path); - } - - /// - public Playlist? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Playlist? DeserializeStream(Stream? data) - { - var deserializer = new PlayJPlaylist(); - return deserializer.Deserialize(data); - } - - /// - public Playlist? Deserialize(Stream? data) + public override Playlist? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -129,7 +71,5 @@ namespace SabreTools.Serialization.Deserializers return playlistHeader; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/PortableExecutable.cs b/SabreTools.Serialization/Deserializers/PortableExecutable.cs index 516da87d..c335b3c0 100644 --- a/SabreTools.Serialization/Deserializers/PortableExecutable.cs +++ b/SabreTools.Serialization/Deserializers/PortableExecutable.cs @@ -5,72 +5,14 @@ using System.Linq; using System.Text; using SabreTools.IO; using SabreTools.Models.PortableExecutable; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.PortableExecutable.Constants; namespace SabreTools.Serialization.Deserializers { - public class PortableExecutable : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class PortableExecutable : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Executable? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new PortableExecutable(); - return deserializer.Deserialize(data, offset); - } - /// - public Executable? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Executable? DeserializeFile(string? path) - { - var deserializer = new PortableExecutable(); - return deserializer.Deserialize(path); - } - - /// - public Executable? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Executable? DeserializeStream(Stream? data) - { - var deserializer = new PortableExecutable(); - return deserializer.Deserialize(data); - } - - /// - public Executable? Deserialize(Stream? data) + public override Executable? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -1387,7 +1329,5 @@ namespace SabreTools.Serialization.Deserializers return resourceDirectoryTable; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/Quantum.cs b/SabreTools.Serialization/Deserializers/Quantum.cs index 1a604c39..01544353 100644 --- a/SabreTools.Serialization/Deserializers/Quantum.cs +++ b/SabreTools.Serialization/Deserializers/Quantum.cs @@ -2,72 +2,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.Quantum; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.Quantum.Constants; namespace SabreTools.Serialization.Deserializers { - public class Quantum : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class Quantum : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Archive? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new Quantum(); - return deserializer.Deserialize(data, offset); - } - /// - public Archive? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Archive? DeserializeFile(string? path) - { - var deserializer = new Quantum(); - return deserializer.Deserialize(path); - } - - /// - public Archive? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Archive? DeserializeStream(Stream? data) - { - var deserializer = new Quantum(); - return deserializer.Deserialize(data); - } - - /// - public Archive? Deserialize(Stream? data) + public override Archive? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -210,7 +152,5 @@ namespace SabreTools.Serialization.Deserializers byte b1 = data.ReadByteValue(); return (b0 << 8) | b1; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/RomCenter.cs b/SabreTools.Serialization/Deserializers/RomCenter.cs index caa5b884..af187d37 100644 --- a/SabreTools.Serialization/Deserializers/RomCenter.cs +++ b/SabreTools.Serialization/Deserializers/RomCenter.cs @@ -4,71 +4,13 @@ using System.Linq; using System.Text; using SabreTools.IO.Readers; using SabreTools.Models.RomCenter; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class RomCenter : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class RomCenter : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static MetadataFile? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new RomCenter(); - return deserializer.Deserialize(data, offset); - } - /// - public MetadataFile? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static MetadataFile? DeserializeFile(string? path) - { - var deserializer = new RomCenter(); - return deserializer.Deserialize(path); - } - - /// - public MetadataFile? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static MetadataFile? DeserializeStream(Stream? data) - { - var deserializer = new RomCenter(); - return deserializer.Deserialize(data); - } - - /// - public MetadataFile? Deserialize(Stream? data) + public override MetadataFile? Deserialize(Stream? data) { // If the stream is null if (data == null) @@ -267,7 +209,5 @@ namespace SabreTools.Serialization.Deserializers } return dat; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/SGA.cs b/SabreTools.Serialization/Deserializers/SGA.cs index b72bb55e..a2ac6abb 100644 --- a/SabreTools.Serialization/Deserializers/SGA.cs +++ b/SabreTools.Serialization/Deserializers/SGA.cs @@ -3,72 +3,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.SGA; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.SGA.Constants; namespace SabreTools.Serialization.Deserializers { - public class SGA : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class SGA : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.SGA.File? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new SGA(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.SGA.File? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.SGA.File? DeserializeFile(string? path) - { - var deserializer = new SGA(); - return deserializer.Deserialize(path); - } - - /// - public Models.SGA.File? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.SGA.File? DeserializeStream(Stream? data) - { - var deserializer = new SGA(); - return deserializer.Deserialize(data); - } - - /// - public Models.SGA.File? Deserialize(Stream? data) + public override Models.SGA.File? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -782,7 +724,5 @@ namespace SabreTools.Serialization.Deserializers return file7; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/SeparatedValue.cs b/SabreTools.Serialization/Deserializers/SeparatedValue.cs index 21d98f03..af710bc3 100644 --- a/SabreTools.Serialization/Deserializers/SeparatedValue.cs +++ b/SabreTools.Serialization/Deserializers/SeparatedValue.cs @@ -4,14 +4,11 @@ using System.Linq; using System.Text; using SabreTools.IO.Readers; using SabreTools.Models.SeparatedValue; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { - public class SeparatedValue : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + // TODO: Create variants for the 3 common types: CSV, SSV, TSV + public class SeparatedValue : BaseBinaryDeserializer { #region Constants @@ -31,7 +28,7 @@ namespace SabreTools.Serialization.Deserializers } /// - public MetadataFile? Deserialize(byte[]? data, int offset) + public override MetadataFile? Deserialize(byte[]? data, int offset) => Deserialize(data, offset, ','); /// @@ -62,7 +59,7 @@ namespace SabreTools.Serialization.Deserializers } /// - public MetadataFile? Deserialize(string? path) + public override MetadataFile? Deserialize(string? path) => Deserialize(path, ','); /// @@ -84,7 +81,7 @@ namespace SabreTools.Serialization.Deserializers } /// - public MetadataFile? Deserialize(Stream? data) + public override MetadataFile? Deserialize(Stream? data) => Deserialize(data, ','); /// diff --git a/SabreTools.Serialization/Deserializers/SoftwareList.cs b/SabreTools.Serialization/Deserializers/SoftwareList.cs index 4646a88b..94589e2b 100644 --- a/SabreTools.Serialization/Deserializers/SoftwareList.cs +++ b/SabreTools.Serialization/Deserializers/SoftwareList.cs @@ -1,39 +1,7 @@ namespace SabreTools.Serialization.Deserializers { - public class SoftwareList : - XmlFile + public class SoftwareList : XmlFile { - #region IByteDeserializer - - /// - public static Models.SoftwareList.SoftwareList? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new SoftwareList(); - return deserializer.Deserialize(data, offset); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.SoftwareList.SoftwareList? DeserializeFile(string? path) - { - var deserializer = new SoftwareList(); - return deserializer.Deserialize(path); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.SoftwareList.SoftwareList? DeserializeStream(System.IO.Stream? data) - { - var deserializer = new SoftwareList(); - return deserializer.Deserialize(data); - } - - #endregion + // All logic taken care of in the base class } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/VBSP.cs b/SabreTools.Serialization/Deserializers/VBSP.cs index e807efc7..951f10f7 100644 --- a/SabreTools.Serialization/Deserializers/VBSP.cs +++ b/SabreTools.Serialization/Deserializers/VBSP.cs @@ -2,72 +2,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.VBSP; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.VBSP.Constants; namespace SabreTools.Serialization.Deserializers { - public class VBSP : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class VBSP : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.VBSP.File? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new VBSP(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.VBSP.File? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.VBSP.File? DeserializeFile(string? path) - { - var deserializer = new VBSP(); - return deserializer.Deserialize(path); - } - - /// - public Models.VBSP.File? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.VBSP.File? DeserializeStream(Stream? data) - { - var deserializer = new VBSP(); - return deserializer.Deserialize(data); - } - - /// - public Models.VBSP.File? Deserialize(Stream? data) + public override Models.VBSP.File? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -165,7 +107,5 @@ namespace SabreTools.Serialization.Deserializers return lump; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/VPK.cs b/SabreTools.Serialization/Deserializers/VPK.cs index 1a551270..f9b2a1d9 100644 --- a/SabreTools.Serialization/Deserializers/VPK.cs +++ b/SabreTools.Serialization/Deserializers/VPK.cs @@ -3,72 +3,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.VPK; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.VPK.Constants; namespace SabreTools.Serialization.Deserializers { - public class VPK : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class VPK : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.VPK.File? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new VPK(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.VPK.File? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.VPK.File? DeserializeFile(string? path) - { - var deserializer = new VPK(); - return deserializer.Deserialize(path); - } - - /// - public Models.VPK.File? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.VPK.File? DeserializeStream(Stream? data) - { - var deserializer = new VPK(); - return deserializer.Deserialize(data); - } - - /// - public Models.VPK.File? Deserialize(Stream? data) + public override Models.VPK.File? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -339,7 +281,5 @@ namespace SabreTools.Serialization.Deserializers return directoryEntry; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/WAD.cs b/SabreTools.Serialization/Deserializers/WAD.cs index 04b65562..67110852 100644 --- a/SabreTools.Serialization/Deserializers/WAD.cs +++ b/SabreTools.Serialization/Deserializers/WAD.cs @@ -2,72 +2,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.WAD; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.WAD.Constants; namespace SabreTools.Serialization.Deserializers { - public class WAD : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class WAD : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.WAD.File? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new WAD(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.WAD.File? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.WAD.File? DeserializeFile(string? path) - { - var deserializer = new WAD(); - return deserializer.Deserialize(path); - } - - /// - public Models.WAD.File? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.WAD.File? DeserializeStream(Stream? data) - { - var deserializer = new WAD(); - return deserializer.Deserialize(data); - } - - /// - public Models.WAD.File? Deserialize(Stream? data) + public override Models.WAD.File? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -298,7 +240,5 @@ namespace SabreTools.Serialization.Deserializers return lumpInfo; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/XZP.cs b/SabreTools.Serialization/Deserializers/XZP.cs index dc7fccf5..668d7f0b 100644 --- a/SabreTools.Serialization/Deserializers/XZP.cs +++ b/SabreTools.Serialization/Deserializers/XZP.cs @@ -2,72 +2,14 @@ using System.IO; using System.Text; using SabreTools.IO; using SabreTools.Models.XZP; -using SabreTools.Serialization.Interfaces; using static SabreTools.Models.XZP.Constants; namespace SabreTools.Serialization.Deserializers { - public class XZP : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class XZP : BaseBinaryDeserializer { - #region IByteDeserializer - - /// - public static Models.XZP.File? DeserializeBytes(byte[]? data, int offset) - { - var deserializer = new XZP(); - return deserializer.Deserialize(data, offset); - } - /// - public Models.XZP.File? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - return null; - - // If the offset is out of bounds - if (offset < 0 || offset >= data.Length) - return null; - - // Create a memory stream and parse that - var dataStream = new MemoryStream(data, offset, data.Length - offset); - return DeserializeStream(dataStream); - } - - #endregion - - #region IFileDeserializer - - /// - public static Models.XZP.File? DeserializeFile(string? path) - { - var deserializer = new XZP(); - return deserializer.Deserialize(path); - } - - /// - public Models.XZP.File? Deserialize(string? path) - { - using var stream = PathProcessor.OpenStream(path); - return DeserializeStream(stream); - } - - #endregion - - #region IStreamDeserializer - - /// - public static Models.XZP.File? DeserializeStream(Stream? data) - { - var deserializer = new XZP(); - return deserializer.Deserialize(data); - } - - /// - public Models.XZP.File? Deserialize(Stream? data) + public override Models.XZP.File? Deserialize(Stream? data) { // If the data is invalid if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) @@ -301,7 +243,5 @@ namespace SabreTools.Serialization.Deserializers return footer; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Deserializers/XmlFile.cs b/SabreTools.Serialization/Deserializers/XmlFile.cs index 01351f44..26aa56e3 100644 --- a/SabreTools.Serialization/Deserializers/XmlFile.cs +++ b/SabreTools.Serialization/Deserializers/XmlFile.cs @@ -2,7 +2,6 @@ using System.IO; using System.Xml; using System.Xml.Schema; using System.Xml.Serialization; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Deserializers { @@ -10,46 +9,10 @@ namespace SabreTools.Serialization.Deserializers /// Base class for other XML deserializers /// /// - public class XmlFile : - IByteDeserializer, - IFileDeserializer, - IStreamDeserializer + public class XmlFile : BaseBinaryDeserializer { - #region IByteDeserializer - /// - public T? Deserialize(byte[]? data, int offset) - { - // If the data is invalid - if (data == null) - 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); - } - - #endregion - - #region IFileDeserializer - - /// - public T? Deserialize(string? path) - { - using var data = PathProcessor.OpenStream(path); - return Deserialize(data); - } - - #endregion - - #region IStreamDeserializer - - /// - public T? Deserialize(Stream? data) + public override T? Deserialize(Stream? data) { // If the stream is null if (data == null) @@ -72,7 +35,5 @@ namespace SabreTools.Serialization.Deserializers // Perform the deserialization and return return (T?)serializer.Deserialize(xmlReader); } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Interfaces/IByteSerializer.cs b/SabreTools.Serialization/Interfaces/IByteSerializer.cs new file mode 100644 index 00000000..7a2c0edd --- /dev/null +++ b/SabreTools.Serialization/Interfaces/IByteSerializer.cs @@ -0,0 +1,16 @@ +namespace SabreTools.Serialization.Interfaces +{ + /// + /// Defines how to serialize to byte arrays + /// + public interface IByteSerializer + { + /// + /// Serialize a into a byte array + /// + /// Type of object to serialize from + /// Data to serialize + /// Filled object on success, null on error + byte[]? SerializeArray(T? obj); + } +} \ No newline at end of file diff --git a/SabreTools.Serialization/Interfaces/IWrapper.cs b/SabreTools.Serialization/Interfaces/IWrapper.cs index 5985746e..dc2b9edf 100644 --- a/SabreTools.Serialization/Interfaces/IWrapper.cs +++ b/SabreTools.Serialization/Interfaces/IWrapper.cs @@ -1,11 +1,20 @@ namespace SabreTools.Serialization.Interfaces { - public interface IWrapper + /// + /// Represents a wrapper around a top-level model + /// + /// Top-level model for the wrapper + public interface IWrapper { /// /// Get a human-readable description of the wrapper /// string Description(); + + /// + /// Get the backing model + /// + TModel GetModel(); #if !NETFRAMEWORK /// diff --git a/SabreTools.Serialization/Serializers/ArchiveDotOrg.cs b/SabreTools.Serialization/Serializers/ArchiveDotOrg.cs index 1bb696a7..b18888b1 100644 --- a/SabreTools.Serialization/Serializers/ArchiveDotOrg.cs +++ b/SabreTools.Serialization/Serializers/ArchiveDotOrg.cs @@ -2,26 +2,6 @@ namespace SabreTools.Serialization.Serializers { public class ArchiveDotOrg : XmlFile { - #region IFileSerializer - - /// - public static bool SerializeFile(Models.ArchiveDotOrg.Files? obj, string? path) - { - var serializer = new ArchiveDotOrg(); - return serializer.Serialize(obj, path); - } - - #endregion - - #region IStreamSerializer - - /// - public static System.IO.Stream? SerializeStream(Models.ArchiveDotOrg.Files? obj) - { - var serializer = new ArchiveDotOrg(); - return serializer.Serialize(obj); - } - - #endregion + // All logic taken care of in the base class } } \ No newline at end of file diff --git a/SabreTools.Serialization/Serializers/AttractMode.cs b/SabreTools.Serialization/Serializers/AttractMode.cs index da6d237e..378d013c 100644 --- a/SabreTools.Serialization/Serializers/AttractMode.cs +++ b/SabreTools.Serialization/Serializers/AttractMode.cs @@ -3,13 +3,10 @@ using System.Linq; using System.Text; using SabreTools.IO.Writers; using SabreTools.Models.AttractMode; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public class AttractMode : - IFileSerializer, - IStreamSerializer + public class AttractMode : BaseBinarySerializer { #region Constants @@ -66,17 +63,44 @@ namespace SabreTools.Serialization.Serializers #endregion - #region IFileSerializer + #region IByteSerializer - /// - public static bool SerializeFile(MetadataFile? obj, string? path, bool longHeader = false) + /// + public static byte[]? SerializeBytes(MetadataFile? obj, bool longHeader = false) { var serializer = new AttractMode(); - return serializer.Serialize(obj, path); + return serializer.SerializeArray(obj, longHeader); } /// - public bool Serialize(MetadataFile? obj, string? path) + public override byte[]? SerializeArray(MetadataFile? obj) + => SerializeArray(obj, false); + + /// + public byte[]? SerializeArray(MetadataFile? obj, bool longHeader) + { + using var stream = SerializeStream(obj, longHeader); + if (stream == null) + return null; + + byte[] bytes = new byte[stream.Length]; + stream.Read(bytes, 0, bytes.Length); + return bytes; + } + + #endregion + + #region IFileSerializer + + /// + public static bool SerializeFile(MetadataFile? obj, string? path, bool longHeader = false) + { + var serializer = new AttractMode(); + return serializer.Serialize(obj, path, longHeader); + } + + /// + public override bool Serialize(MetadataFile? obj, string? path) => Serialize(obj, path, false); /// @@ -98,7 +122,7 @@ namespace SabreTools.Serialization.Serializers #region IStreamSerializer - /// + /// public static Stream? SerializeStream(MetadataFile? obj, bool longHeader = false) { var serializer = new AttractMode(); @@ -106,7 +130,7 @@ namespace SabreTools.Serialization.Serializers } /// - public Stream? Serialize(MetadataFile? obj) + public override Stream? Serialize(MetadataFile? obj) => Serialize(obj, false); /// diff --git a/SabreTools.Serialization/Serializers/BaseBinarySerializer.cs b/SabreTools.Serialization/Serializers/BaseBinarySerializer.cs new file mode 100644 index 00000000..2042c5fc --- /dev/null +++ b/SabreTools.Serialization/Serializers/BaseBinarySerializer.cs @@ -0,0 +1,138 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Reflection; +using SabreTools.Serialization.Interfaces; + +namespace SabreTools.Serialization.Serializers +{ + /// + /// Base class for all binary serializers + /// + /// Type of the model to serialize + /// These methods assume there is a concrete implementation of the serializer for the model available + public abstract class BaseBinarySerializer : + IByteSerializer, + IFileSerializer, + IStreamSerializer + { + #region IByteSerializer + + /// + public virtual byte[]? SerializeArray(TModel? obj) + { + using var stream = SerializeStream(obj); + if (stream == null) + return null; + + byte[] bytes = new byte[stream.Length]; + stream.Read(bytes, 0, bytes.Length); + return bytes; + } + + #endregion + + #region IFileSerializer + + /// + public virtual bool Serialize(TModel? obj, string? path) + { + if (string.IsNullOrEmpty(path)) + return false; + + using var stream = SerializeStream(obj); + if (stream == null) + return false; + + using var fs = File.OpenWrite(path); + stream.CopyTo(fs); + return true; + } + + #endregion + + #region IStreamSerializer + + /// + public abstract Stream? Serialize(TModel? obj); + + #endregion + + #region Static Implementations + + /// + public static byte[]? SerializeBytes(TModel? obj) + { + var serializer = GetType>(); + if (serializer == null) + return default; + + return serializer.SerializeArray(obj); + } + + /// + public static bool SerializeFile(TModel? obj, string? path) + { + var serializer = GetType>(); + if (serializer == null) + return default; + + return serializer.Serialize(obj, path); + } + + /// + public static Stream? SerializeStream(TModel? obj) + { + var serializer = GetType>(); + if (serializer == null) + return default; + + return serializer.Serialize(obj); + } + + #endregion + + #region Helpers + + /// + /// Get a constructed instance of a type, if possible + /// + /// Serializer type to construct + /// Serializer of the requested type, null on error + private static TSerializer? GetType() + { + var assembly = Assembly.GetExecutingAssembly(); + if (assembly == null) + return default; + + // If not all types can be loaded, use the ones that could be + List assemblyTypes = []; + try + { + assemblyTypes = assembly.GetTypes().ToList(); + } + catch (ReflectionTypeLoadException rtle) + { + assemblyTypes = rtle.Types.Where(t => t != null)!.ToList(); + } + + // Loop through all types + foreach (Type type in assemblyTypes) + { + // If the type isn't a class or doesn't implement the interface + if (!type.IsClass || type.GetInterface(typeof(TSerializer).Name) == null) + continue; + + // Try to create a concrete instance of the type + var instance = (TSerializer?)Activator.CreateInstance(type); + if (instance != null) + return instance; + } + + return default; + } + + #endregion + } +} \ No newline at end of file diff --git a/SabreTools.Serialization/Serializers/Catalog.cs b/SabreTools.Serialization/Serializers/Catalog.cs index e91051ed..48274755 100644 --- a/SabreTools.Serialization/Serializers/Catalog.cs +++ b/SabreTools.Serialization/Serializers/Catalog.cs @@ -3,37 +3,10 @@ using System.Text; namespace SabreTools.Serialization.Serializers { - public class Catalog : - JsonFile + public class Catalog : JsonFile { - #region IFileSerializer - - /// - public static bool SerializeFile(Models.Xbox.Catalog? obj, string? path) - { - var serializer = new Catalog(); - return serializer.Serialize(obj, path); - } - - /// Catalog.js file is encoded as UTF-16 LE - public override bool Serialize(Models.Xbox.Catalog? obj, string? path) - => Serialize(obj, path, new UnicodeEncoding()); - - #endregion - - #region IStreamSerializer - - /// - public static Stream? SerializeStream(Models.Xbox.Catalog? obj) - { - var serializer = new Catalog(); - return serializer.Serialize(obj); - } - /// Catalog.js file is encoded as UTF-16 LE public override Stream? Serialize(Models.Xbox.Catalog? obj) => Serialize(obj, new UnicodeEncoding()); - - #endregion } } diff --git a/SabreTools.Serialization/Serializers/ClrMamePro.cs b/SabreTools.Serialization/Serializers/ClrMamePro.cs index dfcf09e9..da21e1eb 100644 --- a/SabreTools.Serialization/Serializers/ClrMamePro.cs +++ b/SabreTools.Serialization/Serializers/ClrMamePro.cs @@ -3,14 +3,38 @@ using System.Linq; using System.Text; using SabreTools.IO.Writers; using SabreTools.Models.ClrMamePro; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public class ClrMamePro : - IFileSerializer, - IStreamSerializer + public class ClrMamePro : BaseBinarySerializer { + #region IByteSerializer + + /// + public static byte[]? SerializeBytes(MetadataFile? obj, bool quotes = false) + { + var serializer = new ClrMamePro(); + return serializer.SerializeArray(obj, quotes); + } + + /// + public override byte[]? SerializeArray(MetadataFile? obj) + => SerializeArray(obj, false); + + /// + public byte[]? SerializeArray(MetadataFile? obj, bool quotes) + { + using var stream = SerializeStream(obj, quotes); + if (stream == null) + return null; + + byte[] bytes = new byte[stream.Length]; + stream.Read(bytes, 0, bytes.Length); + return bytes; + } + + #endregion + #region IFileSerializer /// @@ -21,7 +45,7 @@ namespace SabreTools.Serialization.Serializers } /// - public bool Serialize(MetadataFile? obj, string? path) + public override bool Serialize(MetadataFile? obj, string? path) => Serialize(obj, path, true); /// @@ -51,7 +75,7 @@ namespace SabreTools.Serialization.Serializers } /// - public Stream? Serialize(MetadataFile? obj) + public override Stream? Serialize(MetadataFile? obj) => Serialize(obj, true); /// diff --git a/SabreTools.Serialization/Serializers/CueSheet.cs b/SabreTools.Serialization/Serializers/CueSheet.cs index 15a63c33..428bd7a1 100644 --- a/SabreTools.Serialization/Serializers/CueSheet.cs +++ b/SabreTools.Serialization/Serializers/CueSheet.cs @@ -2,51 +2,13 @@ using System; using System.IO; using System.Text; using SabreTools.Models.CueSheets; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public class CueSheet : - IFileSerializer, - IStreamSerializer + public class CueSheet : BaseBinarySerializer { - #region IFileSerializer - - /// - public static bool SerializeFile(Models.CueSheets.CueSheet? obj, string? path) - { - var serializer = new CueSheet(); - return serializer.Serialize(obj, path); - } - /// - public bool Serialize(Models.CueSheets.CueSheet? obj, string? path) - { - if (string.IsNullOrEmpty(path)) - return false; - - using var stream = SerializeStream(obj); - if (stream == null) - return false; - - using var fs = File.OpenWrite(path); - stream.CopyTo(fs); - return true; - } - - #endregion - - #region IStreamSerializer - - /// - public static Stream? SerializeStream(Models.CueSheets.CueSheet? obj) - { - var serializer = new CueSheet(); - return serializer.Serialize(obj); - } - - /// - public Stream? Serialize(Models.CueSheets.CueSheet? obj) + public override Stream? Serialize(Models.CueSheets.CueSheet? obj) { // If the cuesheet is null if (obj == null) @@ -293,7 +255,5 @@ namespace SabreTools.Serialization.Serializers } #endregion - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Serializers/DosCenter.cs b/SabreTools.Serialization/Serializers/DosCenter.cs index 63ceb043..45241d5c 100644 --- a/SabreTools.Serialization/Serializers/DosCenter.cs +++ b/SabreTools.Serialization/Serializers/DosCenter.cs @@ -3,51 +3,13 @@ using System.Linq; using System.Text; using SabreTools.IO.Writers; using SabreTools.Models.DosCenter; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public class DosCenter : - IFileSerializer, - IStreamSerializer + public class DosCenter : BaseBinarySerializer { - #region IFileSerializer - - /// - public static bool SerializeFile(MetadataFile? obj, string? path) - { - var serializer = new DosCenter(); - return serializer.Serialize(obj, path); - } - /// - public bool Serialize(MetadataFile? obj, string? path) - { - if (string.IsNullOrEmpty(path)) - return false; - - using var stream = SerializeStream(obj); - if (stream == null) - return false; - - using var fs = System.IO.File.OpenWrite(path); - stream.CopyTo(fs); - return true; - } - - #endregion - - #region IStreamSerializer - - /// - public static Stream? SerializeStream(MetadataFile? obj) - { - var serializer = new DosCenter(); - return serializer.Serialize(obj); - } - - /// - public Stream? Serialize(MetadataFile? obj) + public override Stream? Serialize(MetadataFile? obj) { // If the metadata file is null if (obj == null) @@ -160,7 +122,5 @@ namespace SabreTools.Serialization.Serializers writer.WriteEndElement(); // file } } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Serializers/EverdriveSMDB.cs b/SabreTools.Serialization/Serializers/EverdriveSMDB.cs index 6ec346fb..2684fdaf 100644 --- a/SabreTools.Serialization/Serializers/EverdriveSMDB.cs +++ b/SabreTools.Serialization/Serializers/EverdriveSMDB.cs @@ -4,51 +4,13 @@ using System.Linq; using System.Text; using SabreTools.IO.Writers; using SabreTools.Models.EverdriveSMDB; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public class EverdriveSMDB : - IFileSerializer, - IStreamSerializer + public class EverdriveSMDB : BaseBinarySerializer { - #region IFileSerializer - - /// - public static bool SerializeFile(MetadataFile? obj, string? path) - { - var serializer = new EverdriveSMDB(); - return serializer.Serialize(obj, path); - } - /// - public bool Serialize(MetadataFile? obj, string? path) - { - if (string.IsNullOrEmpty(path)) - return false; - - using var stream = SerializeStream(obj); - if (stream == null) - return false; - - using var fs = System.IO.File.OpenWrite(path); - stream.CopyTo(fs); - return true; - } - - #endregion - - #region IStreamSerializer - - /// - public static Stream? SerializeStream(MetadataFile? obj) - { - var serializer = new EverdriveSMDB(); - return serializer.Serialize(obj); - } - - /// - public Stream? Serialize(MetadataFile? obj) + public override Stream? Serialize(MetadataFile? obj) { // If the metadata file is null if (obj == null) @@ -99,7 +61,5 @@ namespace SabreTools.Serialization.Serializers writer.Flush(); } } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Serializers/Hashfile.cs b/SabreTools.Serialization/Serializers/Hashfile.cs index c4439629..f28068e8 100644 --- a/SabreTools.Serialization/Serializers/Hashfile.cs +++ b/SabreTools.Serialization/Serializers/Hashfile.cs @@ -5,14 +5,39 @@ using System.Text; using SabreTools.Hashing; using SabreTools.IO.Writers; using SabreTools.Models.Hashfile; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public class Hashfile : - IFileSerializer, - IStreamSerializer + // TODO: Create variants for the implemented types + public class Hashfile : BaseBinarySerializer { + #region IByteSerializer + + /// + public static byte[]? SerializeBytes(Models.Hashfile.Hashfile? obj, HashType hash = HashType.CRC32) + { + var serializer = new Hashfile(); + return serializer.SerializeArray(obj, hash); + } + + /// + public override byte[]? SerializeArray(Models.Hashfile.Hashfile? obj) + => SerializeArray(obj, HashType.CRC32); + + /// + public byte[]? SerializeArray(Models.Hashfile.Hashfile? obj, HashType hash) + { + using var stream = SerializeStream(obj, hash); + if (stream == null) + return null; + + byte[] bytes = new byte[stream.Length]; + stream.Read(bytes, 0, bytes.Length); + return bytes; + } + + #endregion + #region IFileSerializer /// @@ -23,7 +48,7 @@ namespace SabreTools.Serialization.Serializers } /// - public bool Serialize(Models.Hashfile.Hashfile? obj, string? path) + public override bool Serialize(Models.Hashfile.Hashfile? obj, string? path) => Serialize(obj, path, HashType.CRC32); /// @@ -53,7 +78,7 @@ namespace SabreTools.Serialization.Serializers } /// - public Stream? Serialize(Models.Hashfile.Hashfile? obj) + public override Stream? Serialize(Models.Hashfile.Hashfile? obj) => Serialize(obj, HashType.CRC32); /// diff --git a/SabreTools.Serialization/Serializers/IRD.cs b/SabreTools.Serialization/Serializers/IRD.cs index 573b988e..5e64df16 100644 --- a/SabreTools.Serialization/Serializers/IRD.cs +++ b/SabreTools.Serialization/Serializers/IRD.cs @@ -2,51 +2,13 @@ using System; using System.IO; using System.Linq; using System.Text; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public class IRD : - IFileSerializer, - IStreamSerializer + public class IRD : BaseBinarySerializer { - #region IFileSerializer - - /// - public static bool SerializeFile(Models.IRD.File? obj, string? path) - { - var serializer = new IRD(); - return serializer.Serialize(obj, path); - } - /// - public bool Serialize(Models.IRD.File? obj, string? path) - { - if (string.IsNullOrEmpty(path)) - return false; - - using var stream = SerializeStream(obj); - if (stream == null) - return false; - - using var fs = System.IO.File.OpenWrite(path); - stream.CopyTo(fs); - return true; - } - - #endregion - - #region IStreamSerializer - - /// - public static Stream? SerializeStream(Models.IRD.File? obj) - { - var serializer = new IRD(); - return serializer.Serialize(obj); - } - - /// - public Stream? Serialize(Models.IRD.File? obj) + public override Stream? Serialize(Models.IRD.File? obj) { // If the data is invalid if (obj?.Magic == null) @@ -165,7 +127,5 @@ namespace SabreTools.Serialization.Serializers return stream; } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Serializers/JsonFile.cs b/SabreTools.Serialization/Serializers/JsonFile.cs index 66291a28..8b41f716 100644 --- a/SabreTools.Serialization/Serializers/JsonFile.cs +++ b/SabreTools.Serialization/Serializers/JsonFile.cs @@ -1,7 +1,6 @@ using System.IO; using System.Text; using Newtonsoft.Json; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { @@ -9,14 +8,38 @@ namespace SabreTools.Serialization.Serializers /// Base class for other JSON serializers /// /// - public class JsonFile : - IFileSerializer, - IStreamSerializer + public class JsonFile : BaseBinarySerializer { + #region IByteSerializer + + /// + public override byte[]? SerializeArray(T? obj) + => SerializeArray(obj, new UTF8Encoding(false)); + + /// + /// Serialize a into a byte array + /// + /// Type of object to serialize from + /// Data to serialize + /// Encoding to parse text as + /// Filled object on success, null on error + public byte[]? SerializeArray(T? obj, Encoding encoding) + { + using var stream = Serialize(obj, encoding); + if (stream == null) + return null; + + byte[] bytes = new byte[stream.Length]; + stream.Read(bytes, 0, bytes.Length); + return bytes; + } + + #endregion + #region IFileSerializer /// - public virtual bool Serialize(T? obj, string? path) + public override bool Serialize(T? obj, string? path) => Serialize(obj, path, new UTF8Encoding(false)); /// @@ -47,7 +70,7 @@ namespace SabreTools.Serialization.Serializers #region IStreamSerializer /// - public virtual Stream? Serialize(T? obj) + public override Stream? Serialize(T? obj) => Serialize(obj, new UTF8Encoding(false)); /// diff --git a/SabreTools.Serialization/Serializers/Listrom.cs b/SabreTools.Serialization/Serializers/Listrom.cs index 12818c95..8c52473f 100644 --- a/SabreTools.Serialization/Serializers/Listrom.cs +++ b/SabreTools.Serialization/Serializers/Listrom.cs @@ -2,51 +2,13 @@ using System.IO; using System.Linq; using System.Text; using SabreTools.Models.Listrom; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public class Listrom : - IFileSerializer, - IStreamSerializer + public class Listrom : BaseBinarySerializer { - #region IFileSerializer - - /// - public static bool SerializeFile(MetadataFile? obj, string? path) - { - var serializer = new Listrom(); - return serializer.Serialize(obj, path); - } - /// - public bool Serialize(MetadataFile? obj, string? path) - { - if (string.IsNullOrEmpty(path)) - return false; - - using var stream = SerializeStream(obj); - if (stream == null) - return false; - - using var fs = File.OpenWrite(path); - stream.CopyTo(fs); - return true; - } - - #endregion - - #region IStreamSerializer - - /// - public static Stream? SerializeStream(MetadataFile? obj) - { - var serializer = new Listrom(); - return serializer.Serialize(obj); - } - - /// - public Stream? Serialize(MetadataFile? obj) + public override Stream? Serialize(MetadataFile? obj) { // If the metadata file is null if (obj == null) @@ -192,7 +154,5 @@ namespace SabreTools.Serialization.Serializers writer.Flush(); } } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Serializers/Listxml.cs b/SabreTools.Serialization/Serializers/Listxml.cs index 964ffac5..5127ea1d 100644 --- a/SabreTools.Serialization/Serializers/Listxml.cs +++ b/SabreTools.Serialization/Serializers/Listxml.cs @@ -1,28 +1,7 @@ namespace SabreTools.Serialization.Serializers { - public class Listxml : - XmlFile + public class Listxml : XmlFile { - #region IFileSerializer - - /// - public static bool SerializeFile(Models.Listxml.Mame? obj, string? path) - { - var serializer = new Listxml(); - return serializer.Serialize(obj, path); - } - - #endregion - - #region IStreamSerializer - - /// - public static System.IO.Stream? SerializeStream(Models.Listxml.Mame? obj) - { - var serializer = new Listxml(); - return serializer.Serialize(obj); - } - - #endregion + // All logic taken care of in the base class } } \ No newline at end of file diff --git a/SabreTools.Serialization/Serializers/Logiqx.cs b/SabreTools.Serialization/Serializers/Logiqx.cs index 3a2c4e8a..5ecfce2d 100644 --- a/SabreTools.Serialization/Serializers/Logiqx.cs +++ b/SabreTools.Serialization/Serializers/Logiqx.cs @@ -3,8 +3,7 @@ using SabreTools.Models.Logiqx; namespace SabreTools.Serialization.Serializers { - public class Logiqx : - XmlFile + public class Logiqx : XmlFile { #region Constants @@ -30,15 +29,16 @@ namespace SabreTools.Serialization.Serializers #endregion + #region IByteSerializer + + /// + public override byte[]? SerializeArray(Datafile? obj) + => SerializeArray(obj, DocTypeName, DocTypePubId, DocTypeSysId, DocTypeSysId); + + #endregion + #region IFileSerializer - /// - public static bool SerializeFile(Datafile? obj, string? path) - { - var serializer = new Logiqx(); - return serializer.Serialize(obj, path); - } - /// public override bool Serialize(Datafile? obj, string? path) => Serialize(obj, path, DocTypeName, DocTypePubId, DocTypeSysId, DocTypeSysId); @@ -47,13 +47,6 @@ namespace SabreTools.Serialization.Serializers #region IStreamSerializer - /// - public static Stream? SerializeStream(Datafile? obj) - { - var serializer = new Logiqx(); - return serializer.Serialize(obj); - } - /// public override Stream? Serialize(Datafile? obj) => Serialize(obj, DocTypeName, DocTypePubId, DocTypeSysId, DocTypeSysId); diff --git a/SabreTools.Serialization/Serializers/M1.cs b/SabreTools.Serialization/Serializers/M1.cs index 78541224..25fa12c6 100644 --- a/SabreTools.Serialization/Serializers/M1.cs +++ b/SabreTools.Serialization/Serializers/M1.cs @@ -1,28 +1,7 @@ namespace SabreTools.Serialization.Serializers { - public class M1 : - XmlFile + public class M1 : XmlFile { - #region IFileSerializer - - /// - public static bool SerializeFile(Models.Listxml.M1? obj, string? path) - { - var serializer = new M1(); - return serializer.Serialize(obj, path); - } - - #endregion - - #region IStreamSerializer - - /// - public static System.IO.Stream? SerializeStream(Models.Listxml.M1? obj) - { - var serializer = new M1(); - return serializer.Serialize(obj); - } - - #endregion + // All logic taken care of in the base class } } \ No newline at end of file diff --git a/SabreTools.Serialization/Serializers/OfflineList.cs b/SabreTools.Serialization/Serializers/OfflineList.cs index 49342ba8..007acfcc 100644 --- a/SabreTools.Serialization/Serializers/OfflineList.cs +++ b/SabreTools.Serialization/Serializers/OfflineList.cs @@ -1,28 +1,7 @@ namespace SabreTools.Serialization.Serializers { - public class OfflineList : - XmlFile + public class OfflineList : XmlFile { - #region IFileSerializer - - /// - public static bool SerializeFile(Models.OfflineList.Dat? obj, string? path) - { - var serializer = new OfflineList(); - return serializer.Serialize(obj, path); - } - - #endregion - - #region IStreamSerializer - - /// - public static System.IO.Stream? SerializeStream(Models.OfflineList.Dat? obj) - { - var serializer = new OfflineList(); - return serializer.Serialize(obj); - } - - #endregion + // All logic taken care of in the base class } } \ No newline at end of file diff --git a/SabreTools.Serialization/Serializers/OpenMSX.cs b/SabreTools.Serialization/Serializers/OpenMSX.cs index 56ab36ce..a6364f0d 100644 --- a/SabreTools.Serialization/Serializers/OpenMSX.cs +++ b/SabreTools.Serialization/Serializers/OpenMSX.cs @@ -3,8 +3,7 @@ using SabreTools.Models.OpenMSX; namespace SabreTools.Serialization.Serializers { - public class OpenMSX : - XmlFile + public class OpenMSX : XmlFile { #region Constants @@ -30,15 +29,16 @@ namespace SabreTools.Serialization.Serializers #endregion + #region IByteSerializer + + /// + public override byte[]? SerializeArray(SoftwareDb? obj) + => SerializeArray(obj, DocTypeName, DocTypePubId, DocTypeSysId, DocTypeSysId); + + #endregion + #region IFileSerializer - /// - public static bool SerializeFile(SoftwareDb? obj, string? path) - { - var serializer = new OpenMSX(); - return serializer.Serialize(obj, path); - } - /// public override bool Serialize(SoftwareDb? obj, string? path) => Serialize(obj, path, DocTypeName, DocTypePubId, DocTypeSysId, DocTypeSysId); @@ -47,13 +47,6 @@ namespace SabreTools.Serialization.Serializers #region IStreamSerializer - /// - public static Stream? SerializeStream(SoftwareDb? obj) - { - var serializer = new OpenMSX(); - return serializer.Serialize(obj); - } - /// public override Stream? Serialize(SoftwareDb? obj) => Serialize(obj, DocTypeName, DocTypePubId, DocTypeSysId, DocTypeSysId); diff --git a/SabreTools.Serialization/Serializers/RomCenter.cs b/SabreTools.Serialization/Serializers/RomCenter.cs index 51f89641..54f38b8d 100644 --- a/SabreTools.Serialization/Serializers/RomCenter.cs +++ b/SabreTools.Serialization/Serializers/RomCenter.cs @@ -3,51 +3,13 @@ using System.Linq; using System.Text; using SabreTools.IO.Writers; using SabreTools.Models.RomCenter; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public class RomCenter : - IFileSerializer, - IStreamSerializer + public class RomCenter : BaseBinarySerializer { - #region IFileSerializer - - /// - public static bool SerializeFile(MetadataFile? obj, string? path) - { - var serializer = new RomCenter(); - return serializer.Serialize(obj, path); - } - /// - public bool Serialize(MetadataFile? obj, string? path) - { - if (string.IsNullOrEmpty(path)) - return false; - - using var stream = SerializeStream(obj); - if (stream == null) - return false; - - using var fs = File.OpenWrite(path); - stream.CopyTo(fs); - return true; - } - - #endregion - - #region IStreamSerializer - - /// - public static Stream? SerializeStream(MetadataFile? obj) - { - var serializer = new RomCenter(); - return serializer.Serialize(obj); - } - - /// - public Stream? Serialize(MetadataFile? obj) + public override Stream? Serialize(MetadataFile? obj) { // If the metadata file is null if (obj == null) @@ -199,7 +161,5 @@ namespace SabreTools.Serialization.Serializers writer.WriteLine(); writer.Flush(); } - - #endregion } } \ No newline at end of file diff --git a/SabreTools.Serialization/Serializers/SeparatedValue.cs b/SabreTools.Serialization/Serializers/SeparatedValue.cs index d83317d6..6e09613e 100644 --- a/SabreTools.Serialization/Serializers/SeparatedValue.cs +++ b/SabreTools.Serialization/Serializers/SeparatedValue.cs @@ -3,14 +3,39 @@ using System.Linq; using System.Text; using SabreTools.IO.Writers; using SabreTools.Models.SeparatedValue; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public class SeparatedValue : - IFileSerializer, - IStreamSerializer + // TODO: Create variants for the 3 common types: CSV, SSV, TSV + public class SeparatedValue : BaseBinarySerializer { + #region IByteSerializer + + /// + public static byte[]? SerializeBytes(MetadataFile? obj, char delim = ',', bool longHeader = false) + { + var serializer = new SeparatedValue(); + return serializer.SerializeArray(obj, delim, longHeader); + } + + /// + public override byte[]? SerializeArray(MetadataFile? obj) + => SerializeArray(obj, ',', false); + + /// + public byte[]? SerializeArray(MetadataFile? obj, char delim, bool longHeader) + { + using var stream = SerializeStream(obj, delim, longHeader); + if (stream == null) + return null; + + byte[] bytes = new byte[stream.Length]; + stream.Read(bytes, 0, bytes.Length); + return bytes; + } + + #endregion + #region IFileSerializer /// @@ -21,7 +46,7 @@ namespace SabreTools.Serialization.Serializers } /// - public bool Serialize(MetadataFile? obj, string? path) + public override bool Serialize(MetadataFile? obj, string? path) => Serialize(obj, path, ',', false); /// @@ -51,7 +76,7 @@ namespace SabreTools.Serialization.Serializers } /// - public Stream? Serialize(MetadataFile? obj) + public override Stream? Serialize(MetadataFile? obj) => Serialize(obj, ',', false); /// diff --git a/SabreTools.Serialization/Serializers/SoftwareList.cs b/SabreTools.Serialization/Serializers/SoftwareList.cs index 083256be..24b04f2c 100644 --- a/SabreTools.Serialization/Serializers/SoftwareList.cs +++ b/SabreTools.Serialization/Serializers/SoftwareList.cs @@ -2,8 +2,7 @@ using System.IO; namespace SabreTools.Serialization.Serializers { - public class SoftwareList : - XmlFile + public class SoftwareList : XmlFile { #region Constants @@ -31,13 +30,6 @@ namespace SabreTools.Serialization.Serializers #region IFileSerializer - /// - public static bool SerializeFile(Models.SoftwareList.SoftwareList? obj, string? path) - { - var serializer = new SoftwareList(); - return serializer.Serialize(obj, path); - } - /// public override bool Serialize(Models.SoftwareList.SoftwareList? obj, string? path) => Serialize(obj, path, DocTypeName, DocTypePubId, DocTypeSysId, DocTypeSysId); @@ -46,13 +38,6 @@ namespace SabreTools.Serialization.Serializers #region IStreamSerializer - /// - public static Stream? SerializeStream(Models.SoftwareList.SoftwareList? obj) - { - var serializer = new SoftwareList(); - return serializer.Serialize(obj); - } - /// public override Stream? Serialize(Models.SoftwareList.SoftwareList? obj) => Serialize(obj, DocTypeName, DocTypePubId, DocTypeSysId, DocTypeSysId); diff --git a/SabreTools.Serialization/Serializers/XMID.cs b/SabreTools.Serialization/Serializers/XMID.cs index 5e829b48..629b412b 100644 --- a/SabreTools.Serialization/Serializers/XMID.cs +++ b/SabreTools.Serialization/Serializers/XMID.cs @@ -3,8 +3,7 @@ using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public partial class XMID : - IStringSerializer + public partial class XMID : IStringSerializer { #region IStringSerializer diff --git a/SabreTools.Serialization/Serializers/XeMID.cs b/SabreTools.Serialization/Serializers/XeMID.cs index b7474253..5f92fcae 100644 --- a/SabreTools.Serialization/Serializers/XeMID.cs +++ b/SabreTools.Serialization/Serializers/XeMID.cs @@ -3,8 +3,7 @@ using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { - public partial class XeMID : - IStringSerializer + public partial class XeMID : IStringSerializer { #region IStringSerializer diff --git a/SabreTools.Serialization/Serializers/XmlFile.cs b/SabreTools.Serialization/Serializers/XmlFile.cs index 18d8d6d8..a185c675 100644 --- a/SabreTools.Serialization/Serializers/XmlFile.cs +++ b/SabreTools.Serialization/Serializers/XmlFile.cs @@ -2,7 +2,6 @@ using System.IO; using System.Text; using System.Xml; using System.Xml.Serialization; -using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Serializers { @@ -10,14 +9,40 @@ namespace SabreTools.Serialization.Serializers /// Base class for other XML serializers /// /// - public class XmlFile : - IFileSerializer, - IStreamSerializer + public class XmlFile : BaseBinarySerializer { + #region IByteSerializer + + /// + public override byte[]? SerializeArray(T? obj) + => SerializeArray(obj, null, null, null, null); + + /// + /// Serializes the defined type to a byte array + /// + /// Data to serialize + /// Optional DOCTYPE name + /// Optional DOCTYPE pubid + /// Optional DOCTYPE sysid + /// Optional DOCTYPE name + /// Byte array containing serialized data on success, null otherwise + public byte[]? SerializeArray(T? obj, string? name = null, string? pubid = null, string? sysid = null, string? subset = null) + { + using var stream = Serialize(obj, name, pubid, sysid, subset); + if (stream == null) + return null; + + byte[] bytes = new byte[stream.Length]; + stream.Read(bytes, 0, bytes.Length); + return bytes; + } + + #endregion + #region IFileSerializer /// - public virtual bool Serialize(T? obj, string? path) + public override bool Serialize(T? obj, string? path) => Serialize(obj, path, null, null, null, null); /// @@ -49,12 +74,8 @@ namespace SabreTools.Serialization.Serializers #region IStreamSerializer - /// - /// Serializes the defined type to a stream - /// - /// Data to serialize - /// Stream containing serialized data on success, null otherwise - public virtual Stream? Serialize(T? obj) + /// + public override Stream? Serialize(T? obj) => Serialize(obj, null, null, null, null); /// diff --git a/SabreTools.Serialization/Wrappers/GCF.cs b/SabreTools.Serialization/Wrappers/GCF.cs index 598e9f83..323fae83 100644 --- a/SabreTools.Serialization/Wrappers/GCF.cs +++ b/SabreTools.Serialization/Wrappers/GCF.cs @@ -1,7 +1,5 @@ using System.Collections.Generic; using System.IO; -using SabreTools.Models.CHD; -using SabreTools.Models.CueSheets; namespace SabreTools.Serialization.Wrappers { diff --git a/SabreTools.Serialization/Wrappers/LinearExecutable.cs b/SabreTools.Serialization/Wrappers/LinearExecutable.cs index 78e439ec..0f057e35 100644 --- a/SabreTools.Serialization/Wrappers/LinearExecutable.cs +++ b/SabreTools.Serialization/Wrappers/LinearExecutable.cs @@ -26,12 +26,14 @@ namespace SabreTools.Serialization.Wrappers : base(model, data) { // All logic is handled by the base class - }/// - /// Create an LE/LX executable from a byte array and offset - /// - /// Byte array representing the executable - /// Offset within the array to parse - /// An LE/LX executable wrapper on success, null on failure + } + + /// + /// Create an LE/LX executable from a byte array and offset + /// + /// Byte array representing the executable + /// Offset within the array to parse + /// An LE/LX executable wrapper on success, null on failure public static LinearExecutable? Create(byte[]? data, int offset) { // If the data is invalid diff --git a/SabreTools.Serialization/Wrappers/MSDOS.cs b/SabreTools.Serialization/Wrappers/MSDOS.cs index e70b8ccf..b275439e 100644 --- a/SabreTools.Serialization/Wrappers/MSDOS.cs +++ b/SabreTools.Serialization/Wrappers/MSDOS.cs @@ -25,12 +25,14 @@ namespace SabreTools.Serialization.Wrappers : base(model, data) { // All logic is handled by the base class - }/// - /// Create an MS-DOS executable from a byte array and offset - /// - /// Byte array representing the executable - /// Offset within the array to parse - /// An MS-DOS executable wrapper on success, null on failure + } + + /// + /// Create an MS-DOS executable from a byte array and offset + /// + /// Byte array representing the executable + /// Offset within the array to parse + /// An MS-DOS executable wrapper on success, null on failure public static MSDOS? Create(byte[]? data, int offset) { // If the data is invalid diff --git a/SabreTools.Serialization/Wrappers/MicrosoftCabinet.cs b/SabreTools.Serialization/Wrappers/MicrosoftCabinet.cs index aae4aa05..af874b2f 100644 --- a/SabreTools.Serialization/Wrappers/MicrosoftCabinet.cs +++ b/SabreTools.Serialization/Wrappers/MicrosoftCabinet.cs @@ -26,12 +26,14 @@ namespace SabreTools.Serialization.Wrappers : base(model, data) { // All logic is handled by the base class - }/// - /// Create a Microsoft Cabinet from a byte array and offset - /// - /// Byte array representing the cabinet - /// Offset within the array to parse - /// A cabinet wrapper on success, null on failure + } + + /// + /// Create a Microsoft Cabinet from a byte array and offset + /// + /// Byte array representing the cabinet + /// Offset within the array to parse + /// A cabinet wrapper on success, null on failure public static MicrosoftCabinet? Create(byte[]? data, int offset) { // If the data is invalid diff --git a/SabreTools.Serialization/Wrappers/MoPaQ.cs b/SabreTools.Serialization/Wrappers/MoPaQ.cs new file mode 100644 index 00000000..57659de2 --- /dev/null +++ b/SabreTools.Serialization/Wrappers/MoPaQ.cs @@ -0,0 +1,79 @@ +using System.IO; + +namespace SabreTools.Serialization.Wrappers +{ + // TODO: Figure out extension properties + public partial class MoPaQ : WrapperBase + { + #region Descriptive Properties + + /// + public override string DescriptionString => "MoPaQ Archive"; + + #endregion + + #region Constructors + + /// + public MoPaQ(Models.MoPaQ.Archive? model, byte[]? data, int offset) + : base(model, data, offset) + { + // All logic is handled by the base class + } + + /// + public MoPaQ(Models.MoPaQ.Archive? model, Stream? data) + : base(model, data) + { + // All logic is handled by the base class + } + + /// + /// Create a MoPaQ archive from a byte array and offset + /// + /// Byte array representing the archive + /// Offset within the array to parse + /// A MoPaQ archive wrapper on success, null on failure + public static MoPaQ? Create(byte[]? data, int offset) + { + // If the data is invalid + if (data == null) + return null; + + // If the offset is out of bounds + if (offset < 0 || offset >= data.Length) + return null; + + // Create a memory stream and use that + var dataStream = new MemoryStream(data, offset, data.Length - offset); + return Create(dataStream); + } + + /// + /// Create a MoPaQ archive from a Stream + /// + /// Stream representing the archive + /// A MoPaQ archive wrapper on success, null on failure + public static MoPaQ? Create(Stream? data) + { + // If the data is invalid + if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) + return null; + + var archive = Deserializers.MoPaQ.DeserializeStream(data); + if (archive == null) + return null; + + try + { + return new MoPaQ(archive, data); + } + catch + { + return null; + } + } + + #endregion + } +} diff --git a/SabreTools.Serialization/Wrappers/PFF.cs b/SabreTools.Serialization/Wrappers/PFF.cs index 0f0d2c1f..736b952a 100644 --- a/SabreTools.Serialization/Wrappers/PFF.cs +++ b/SabreTools.Serialization/Wrappers/PFF.cs @@ -1,5 +1,4 @@ using System.IO; -using System.Text; namespace SabreTools.Serialization.Wrappers { @@ -26,12 +25,14 @@ namespace SabreTools.Serialization.Wrappers : base(model, data) { // All logic is handled by the base class - }/// - /// Create a PFF archive from a byte array and offset - /// - /// Byte array representing the archive - /// Offset within the array to parse - /// A PFF archive wrapper on success, null on failure + } + + /// + /// Create a PFF archive from a byte array and offset + /// + /// Byte array representing the archive + /// Offset within the array to parse + /// A PFF archive wrapper on success, null on failure public static PFF? Create(byte[]? data, int offset) { // If the data is invalid diff --git a/SabreTools.Serialization/Wrappers/PIC.cs b/SabreTools.Serialization/Wrappers/PIC.cs new file mode 100644 index 00000000..ea59ce5d --- /dev/null +++ b/SabreTools.Serialization/Wrappers/PIC.cs @@ -0,0 +1,79 @@ +using System.IO; + +namespace SabreTools.Serialization.Wrappers +{ + // TODO: Figure out extension properties + public class PIC : WrapperBase + { + #region Descriptive Properties + + /// + public override string DescriptionString => "Disc Information"; + + #endregion + + #region Constructors + + /// + public PIC(Models.PIC.DiscInformation? model, byte[]? data, int offset) + : base(model, data, offset) + { + // All logic is handled by the base class + } + + /// + public PIC(Models.PIC.DiscInformation? model, Stream? data) + : base(model, data) + { + // All logic is handled by the base class + } + + /// + /// Create a PIC disc information object from a byte array and offset + /// + /// Byte array representing the information + /// Offset within the array to parse + /// A PIC disc information wrapper on success, null on failure + public static PIC? Create(byte[]? data, int offset) + { + // If the data is invalid + if (data == null) + return null; + + // If the offset is out of bounds + if (offset < 0 || offset >= data.Length) + return null; + + // Create a memory stream and use that + var dataStream = new MemoryStream(data, offset, data.Length - offset); + return Create(dataStream); + } + + /// + /// Create a PIC disc information object from a Stream + /// + /// Stream representing the information + /// A PIC disc information wrapper on success, null on failure + public static PIC? Create(Stream? data) + { + // If the data is invalid + if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) + return null; + + var info = Deserializers.PIC.DeserializeStream(data); + if (info == null) + return null; + + try + { + return new PIC(info, data); + } + catch + { + return null; + } + } + + #endregion + } +} \ No newline at end of file diff --git a/SabreTools.Serialization/Wrappers/PlayJAudioFile.cs b/SabreTools.Serialization/Wrappers/PlayJAudioFile.cs index 5acd88ce..59512058 100644 --- a/SabreTools.Serialization/Wrappers/PlayJAudioFile.cs +++ b/SabreTools.Serialization/Wrappers/PlayJAudioFile.cs @@ -30,7 +30,7 @@ namespace SabreTools.Serialization.Wrappers /// /// Create a PlayJ audio file from a byte array and offset /// - /// Byte array representing the archive + /// Byte array representing the audio file /// Offset within the array to parse /// A PlayJ audio file wrapper on success, null on failure public static PlayJAudioFile? Create(byte[]? data, int offset) @@ -51,7 +51,7 @@ namespace SabreTools.Serialization.Wrappers /// /// Create a PlayJ audio file from a Stream /// - /// Stream representing the archive + /// Stream representing the audio file /// A PlayJ audio file wrapper on success, null on failure public static PlayJAudioFile? Create(Stream? data) { diff --git a/SabreTools.Serialization/Wrappers/PlayJPlaylist.cs b/SabreTools.Serialization/Wrappers/PlayJPlaylist.cs new file mode 100644 index 00000000..086acaee --- /dev/null +++ b/SabreTools.Serialization/Wrappers/PlayJPlaylist.cs @@ -0,0 +1,78 @@ +using System.IO; + +namespace SabreTools.Serialization.Wrappers +{ + public class PlayJPlaylist : WrapperBase + { + #region Descriptive Properties + + /// + public override string DescriptionString => "PlayJ Playlist"; + + #endregion + + #region Constructors + + /// + public PlayJPlaylist(Models.PlayJ.Playlist? model, byte[]? data, int offset) + : base(model, data, offset) + { + // All logic is handled by the base class + } + + /// + public PlayJPlaylist(Models.PlayJ.Playlist? model, Stream? data) + : base(model, data) + { + // All logic is handled by the base class + } + + /// + /// Create a PlayJ playlist from a byte array and offset + /// + /// Byte array representing the playlist + /// Offset within the array to parse + /// A PlayJ playlist wrapper on success, null on failure + public static PlayJPlaylist? Create(byte[]? data, int offset) + { + // If the data is invalid + if (data == null) + return null; + + // If the offset is out of bounds + if (offset < 0 || offset >= data.Length) + return null; + + // Create a memory stream and use that + var dataStream = new MemoryStream(data, offset, data.Length - offset); + return Create(dataStream); + } + + /// + /// Create a PlayJ playlist from a Stream + /// + /// Stream representing the playlist + /// A PlayJ playlist wrapper on success, null on failure + public static PlayJPlaylist? Create(Stream? data) + { + // If the data is invalid + if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead) + return null; + + var playlist = Deserializers.PlayJPlaylist.DeserializeStream(data); + if (playlist == null) + return null; + + try + { + return new PlayJPlaylist(playlist, data); + } + catch + { + return null; + } + } + + #endregion + } +} \ No newline at end of file diff --git a/SabreTools.Serialization/Wrappers/WrapperBase.cs b/SabreTools.Serialization/Wrappers/WrapperBase.cs index 7ab54896..4805c188 100644 --- a/SabreTools.Serialization/Wrappers/WrapperBase.cs +++ b/SabreTools.Serialization/Wrappers/WrapperBase.cs @@ -8,7 +8,7 @@ using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Wrappers { - public abstract class WrapperBase : IWrapper + public abstract class WrapperBase : IWrapper { #region Descriptive Properties @@ -24,6 +24,9 @@ namespace SabreTools.Serialization.Wrappers #region Properties + /// + public T GetModel() => Model; + /// /// Internal model ///