Add "very useful method" to interface

SabreTools · Apr 4, 2024 · ead32b3 · ead32b3
1 parent b320fc8
commit ead32b3
Show file tree

Hide file tree

Showing 29 changed files with 123 additions and 3 deletions.
diff --git a/SabreTools.Printing/AACSMediaKeyBlock.cs b/SabreTools.Printing/AACSMediaKeyBlock.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class AACSMediaKeyBlock : IPrinter<MediaKeyBlock>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, MediaKeyBlock model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, MediaKeyBlock mediaKeyBlock)
         {
             builder.AppendLine("AACS Media Key Block Information:");

diff --git a/SabreTools.Printing/BDPlusSVM.cs b/SabreTools.Printing/BDPlusSVM.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class BDPlusSVM : IPrinter<SVM>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, SVM model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, SVM svm)
         {
             builder.AppendLine("BD+ SVM Information:");

diff --git a/SabreTools.Printing/BFPK.cs b/SabreTools.Printing/BFPK.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class BFPK : IPrinter<Archive>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Archive model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Archive archive)
         {
             builder.AppendLine("BFPK Information:");

diff --git a/SabreTools.Printing/BSP.cs b/SabreTools.Printing/BSP.cs
@@ -6,6 +6,10 @@ namespace SabreTools.Printing
 {
     public class BSP : IPrinter<File>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, File model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, File file)
         {
             builder.AppendLine("BSP Information:");

diff --git a/SabreTools.Printing/CFB.cs b/SabreTools.Printing/CFB.cs
@@ -6,6 +6,10 @@ namespace SabreTools.Printing
 {
     public class CFB : IPrinter<Binary>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Binary model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Binary binary)
         {
             builder.AppendLine("Compound File Binary Information:");

diff --git a/SabreTools.Printing/CIA.cs b/SabreTools.Printing/CIA.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class CIA : IPrinter<Models.N3DS.CIA>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Models.N3DS.CIA model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Models.N3DS.CIA cia)
         {
             builder.AppendLine("CIA Archive Information:");

diff --git a/SabreTools.Printing/GCF.cs b/SabreTools.Printing/GCF.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class GCF : IPrinter<File>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, File model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, File file)
         {
             builder.AppendLine("GCF Information:");

diff --git a/SabreTools.Printing/IPrinter.cs b/SabreTools.Printing/IPrinter.cs
@@ -1,3 +1,5 @@
+using System.Text;
+
 namespace SabreTools.Printing
 {
     /// <summary>
@@ -6,6 +8,11 @@ namespace SabreTools.Printing
     /// <typeparam name="TModel">Type of the top-level model</typeparam>
     public interface IPrinter<TModel>
     {
-        // Empty interface to associate a model with a printer
+        /// <summary>
+        /// Print information associated with a model
+        /// </summary>
+        /// <param name="builder">StringBuilder to append information to</param>
+        /// <param name="model">Model to print</param>
+        void PrintInformation(StringBuilder builder, TModel model);
     }
 }
diff --git a/SabreTools.Printing/IRD.cs b/SabreTools.Printing/IRD.cs
@@ -1,10 +1,15 @@
 using System.Text;
+using SabreTools.Models.IRD;
 
 namespace SabreTools.Printing
 {
-    public class IRD : IPrinter<Models.IRD.File>
+    public class IRD : IPrinter<File>
     {
-        public static void Print(StringBuilder builder, Models.IRD.File ird)
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, File model)
+            => Print(builder, model);
+
+        public static void Print(StringBuilder builder, File ird)
         {
             builder.AppendLine("IRD Information:");
             builder.AppendLine("-------------------------");

diff --git a/SabreTools.Printing/InstallShieldCabinet.cs b/SabreTools.Printing/InstallShieldCabinet.cs
@@ -6,6 +6,10 @@ namespace SabreTools.Printing
 {
     public class InstallShieldCabinet : IPrinter<Cabinet>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Cabinet model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Cabinet cabinet)
         {
             builder.AppendLine("InstallShield Cabinet Information:");

diff --git a/SabreTools.Printing/LinearExecutable.cs b/SabreTools.Printing/LinearExecutable.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class LinearExecutable : IPrinter<Executable>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Executable model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Executable executable)
         {
             builder.AppendLine("New Executable Information:");

diff --git a/SabreTools.Printing/MSDOS.cs b/SabreTools.Printing/MSDOS.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class MSDOS : IPrinter<Executable>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Executable model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Executable executable)
         {
             builder.AppendLine("MS-DOS Executable Information:");

diff --git a/SabreTools.Printing/MicrosoftCabinet.cs b/SabreTools.Printing/MicrosoftCabinet.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class MicrosoftCabinet : IPrinter<Cabinet>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Cabinet model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Cabinet cabinet)
         {
             builder.AppendLine("Microsoft Cabinet Information:");

diff --git a/SabreTools.Printing/N3DS.cs b/SabreTools.Printing/N3DS.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class N3DS : IPrinter<Cart>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Cart model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Cart cart)
         {
             builder.AppendLine("3DS Cart Information:");

diff --git a/SabreTools.Printing/NCF.cs b/SabreTools.Printing/NCF.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class NCF : IPrinter<File>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, File model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, File file)
         {
             builder.AppendLine("NCF Information:");

diff --git a/SabreTools.Printing/NewExecutable.cs b/SabreTools.Printing/NewExecutable.cs
@@ -7,6 +7,10 @@ namespace SabreTools.Printing
 {
     public class NewExecutable : IPrinter<Executable>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Executable model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Executable executable)
         {
             builder.AppendLine("New Executable Information:");

diff --git a/SabreTools.Printing/Nitro.cs b/SabreTools.Printing/Nitro.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class Nitro : IPrinter<Cart>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Cart model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Cart cart)
         {
             builder.AppendLine("NDS Cart Information:");

diff --git a/SabreTools.Printing/PAK.cs b/SabreTools.Printing/PAK.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class PAK : IPrinter<File>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, File model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, File file)
         {
             builder.AppendLine("PAK Information:");

diff --git a/SabreTools.Printing/PFF.cs b/SabreTools.Printing/PFF.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class PFF : IPrinter<Archive>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Archive model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Archive archive)
         {
             builder.AppendLine("PFF Information:");

diff --git a/SabreTools.Printing/PlayJAudioFile.cs b/SabreTools.Printing/PlayJAudioFile.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class PlayJAudioFile : IPrinter<AudioFile>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, AudioFile model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, AudioFile audio)
         {
             builder.AppendLine("PlayJ Audio File Information:");

diff --git a/SabreTools.Printing/PortableExecutable.cs b/SabreTools.Printing/PortableExecutable.cs
@@ -12,6 +12,10 @@ namespace SabreTools.Printing
 {
     public class PortableExecutable : IPrinter<Executable>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Executable model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Executable executable)
         {
             builder.AppendLine("Portable Executable Information:");

diff --git a/SabreTools.Printing/Quantum.cs b/SabreTools.Printing/Quantum.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class Quantum : IPrinter<Archive>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Archive model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Archive archive)
         {
             builder.AppendLine("Quantum Information:");

diff --git a/SabreTools.Printing/SGA.cs b/SabreTools.Printing/SGA.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class SGA : IPrinter<File>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, File model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, File file)
         {
             builder.AppendLine("SGA Information:");

diff --git a/SabreTools.Printing/VBSP.cs b/SabreTools.Printing/VBSP.cs
@@ -6,6 +6,10 @@ namespace SabreTools.Printing
 {
     public class VBSP : IPrinter<File>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, File model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, File file)
         {
             builder.AppendLine("VBSP Information:");

diff --git a/SabreTools.Printing/VPK.cs b/SabreTools.Printing/VPK.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class VPK : IPrinter<File>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, File model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, File file)
         {
             builder.AppendLine("VPK Information:");

diff --git a/SabreTools.Printing/WAD.cs b/SabreTools.Printing/WAD.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class WAD : IPrinter<File>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, File model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, File file)
         {
             builder.AppendLine("WAD Information:");

diff --git a/SabreTools.Printing/XMID.cs b/SabreTools.Printing/XMID.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class XMID : IPrinter<Models.Xbox.XMID>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Models.Xbox.XMID model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Models.Xbox.XMID xmid)
         {
             builder.AppendLine("Xbox Media Identifier Information:");

diff --git a/SabreTools.Printing/XZP.cs b/SabreTools.Printing/XZP.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class XZP : IPrinter<File>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, File model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, File file)
         {
             builder.AppendLine("XZP Information:");

diff --git a/SabreTools.Printing/XeMID.cs b/SabreTools.Printing/XeMID.cs
@@ -5,6 +5,10 @@ namespace SabreTools.Printing
 {
     public class XeMID : IPrinter<Models.Xbox.XeMID>
     {
+        /// <inheritdoc/>
+        public void PrintInformation(StringBuilder builder, Models.Xbox.XeMID model)
+            => Print(builder, model);
+
         public static void Print(StringBuilder builder, Models.Xbox.XeMID xemid)
         {
             builder.AppendLine("Xbox Media Identifier Information:");