Make "decompile" an MSI-only command instead of a backend requirement

As much as I'd like decompiling to be global functionality provided
by all backends there are only two output types that support
decompiling: MSI and MSM. In the future, perhaps we can invest in a
generic symbols to source code converter that would reduce the
redundant work backends need to do today. Until then, make
decompile an MSI specific command

7 files changed, 133 insertions, 47 deletions

diff --git a/src/api/wix/WixToolset.Extensibility/Data/IDecompileContext.cs b/src/api/wix/WixToolset.Extensibility/Data/IWindowsInstallerDecompileContext.cs
index fe7d0465..f744121a 100644
--- a/src/api/wix/WixToolset.Extensibility/Data/IDecompileContext.cs
+++ b/src/api/wix/WixToolset.Extensibility/Data/IWindowsInstallerDecompileContext.cs
@@ -5,21 +5,40 @@ namespace WixToolset.Extensibility.Data
     using System;
     using System.Collections.Generic;
     using WixToolset.Data;
-    using WixToolset.Extensibility.Services;
 
-#pragma warning disable 1591 // TODO: add documentation
-    public interface IDecompileContext
+    /// <summary>
+    /// The context used to decompile Windows Installer packages.
+    /// </summary>
+    public interface IWindowsInstallerDecompileContext
     {
+        /// <summary>
+        /// Gets or sets the service provider.
+        /// </summary>
         IServiceProvider ServiceProvider { get; }
 
+        /// <summary>
+        /// Gets or sets the path to the file to decompile.
+        /// </summary>
         string DecompilePath { get; set; }
 
+        /// <summary>
+        /// Gets or sets the type to decompile.
+        /// </summary>
         OutputType DecompileType { get; set; }
 
-        IReadOnlyCollection<IDecompilerExtension> Extensions { get; set; }
+        /// <summary>
+        /// Gets or sets the decompiler extensions.
+        /// </summary>
+        IReadOnlyCollection<IWindowsInstallerDecompilerExtension> Extensions { get; set; }
 
+        /// <summary>
+        /// Gets or sets the folder where content is extracted.
+        /// </summary>
         string ExtractFolder { get; set; }
 
+        /// <summary>
+        /// Gets or sets the folder where files are extracted.
+        /// </summary>
         string CabinetExtractFolder { get; set; }
 
         /// <summary>
@@ -28,10 +47,19 @@ namespace WixToolset.Extensibility.Data
         /// <remarks>Default value is "SourceDir" to enable use of BindPaths.</remarks>
         string BaseSourcePath { get; set; }
 
+        /// <summary>
+        /// Gets or sets the intermediate folder.
+        /// </summary>
         string IntermediateFolder { get; set; }
 
+        /// <summary>
+        /// Gets or sets whether the decompiler admin image.
+        /// </summary>
         bool IsAdminImage { get; set; }
 
+        /// <summary>
+        /// Gets or sets where to output the result.
+        /// </summary>
         string OutputPath { get; set; }
 
         /// <summary>
@@ -44,9 +72,17 @@ namespace WixToolset.Extensibility.Data
         /// </summary>
         bool SuppressDroppingEmptyTables { get; set; }
 
+        /// <summary>
+        /// Gets or sets whether to prevent extract cabinets.
+        /// </summary>
         bool SuppressExtractCabinets { get; set; }
 
         /// <summary>
+        /// Gets or sets whether to suppress relative action sequencing.
+        /// </summary>
+        bool SuppressRelativeActionSequencing { get; set; }
+
+        /// <summary>
         /// Gets or sets the option to suppress decompiling UI-related tables.
         /// </summary>
         bool SuppressUI { get; set; }
diff --git a/src/api/wix/WixToolset.Extensibility/Data/IDecompileResult.cs b/src/api/wix/WixToolset.Extensibility/Data/IWindowsInstallerDecompileResult.cs
index cffd0976..3b1dd815 100644
--- a/src/api/wix/WixToolset.Extensibility/Data/IDecompileResult.cs
+++ b/src/api/wix/WixToolset.Extensibility/Data/IWindowsInstallerDecompileResult.cs
@@ -7,7 +7,7 @@ namespace WixToolset.Extensibility.Data
     using WixToolset.Data;
 
 #pragma warning disable 1591 // TODO: add documentation
-    public interface IDecompileResult
+    public interface IWindowsInstallerDecompileResult
     {
         XDocument Document { get; set; }
 
diff --git a/src/api/wix/WixToolset.Extensibility/IBackend.cs b/src/api/wix/WixToolset.Extensibility/IBackend.cs
index cb151e05..720abe15 100644
--- a/src/api/wix/WixToolset.Extensibility/IBackend.cs
+++ b/src/api/wix/WixToolset.Extensibility/IBackend.cs
@@ -15,8 +15,5 @@ namespace WixToolset.Extensibility
         /// <param name="context">Bind context.</param>
         /// <returns>Result of the bind operation.</returns>
         IBindResult Bind(IBindContext context);
-
-#pragma warning disable 1591 // TODO: add documentation
-        IDecompileResult Decompile(IDecompileContext context);
     }
 }
diff --git a/src/api/wix/WixToolset.Extensibility/IBackendFactory.cs b/src/api/wix/WixToolset.Extensibility/IBackendFactory.cs
index 7f9ef62d..8e84f5b6 100644
--- a/src/api/wix/WixToolset.Extensibility/IBackendFactory.cs
+++ b/src/api/wix/WixToolset.Extensibility/IBackendFactory.cs
@@ -3,7 +3,7 @@
 namespace WixToolset.Extensibility
 {
     /// <summary>
-    /// Implemented by extensions to create backends.
+    /// Implemented by extensions that are backends.
     /// </summary>
     public interface IBackendFactory
     {
@@ -12,8 +12,8 @@ namespace WixToolset.Extensibility
         /// </summary>
         /// <param name="outputType">Type of output being created.</param>
         /// <param name="outputPath">Path to the output to create.</param>
-        /// <param name="backend">The backend for the output.</param>
+        /// <param name="binder">The backend for the output.</param>
         /// <returns>True if the backend was created, otherwise false.</returns>
-        bool TryCreateBackend(string outputType, string outputPath, out IBackend backend);
+        bool TryCreateBackend(string outputType, string outputPath, out IBackend binder);
     }
 }
diff --git a/src/api/wix/WixToolset.Extensibility/IDecompilerExtension.cs b/src/api/wix/WixToolset.Extensibility/IDecompilerExtension.cs
deleted file mode 100644
index 24ef3bff..00000000
--- a/src/api/wix/WixToolset.Extensibility/IDecompilerExtension.cs
+++ /dev/null
@@ -1,22 +0,0 @@
-// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
-
-namespace WixToolset.Extensibility
-{
-    using WixToolset.Extensibility.Data;
-
-    /// <summary>
-    /// Base class for creating a decompiler extension.
-    /// </summary>
-    public interface IDecompilerExtension
-    {
-        /// <summary>
-        /// Called before decompiling occurs.
-        /// </summary>
-        void PreDecompile(IDecompileContext context);
-
-        /// <summary>
-        /// Called after all decompiling occurs.
-        /// </summary>
-        void PostDecompile(IDecompileResult result);
-    }
-}
diff --git a/src/api/wix/WixToolset.Extensibility/IWindowsInstallerBackendDecompilerExtension.cs b/src/api/wix/WixToolset.Extensibility/IWindowsInstallerDecompilerExtension.cs
index a56b63c3..add5f886 100644
--- a/src/api/wix/WixToolset.Extensibility/IWindowsInstallerBackendDecompilerExtension.cs
+++ b/src/api/wix/WixToolset.Extensibility/IWindowsInstallerDecompilerExtension.cs
@@ -9,18 +9,18 @@ namespace WixToolset.Extensibility
     /// <summary>
     /// Interface all binder extensions implement.
     /// </summary>
-    public interface IWindowsInstallerBackendDecompilerExtension
+    public interface IWindowsInstallerDecompilerExtension
     {
         /// <summary>
         /// Called before decompiling occurs.
         /// </summary>
-        void PreBackendDecompile(IDecompileContext context);
+        void PreDecompile(IWindowsInstallerDecompileContext context);
 
         // TODO: Redesign this interface to be useful.
 
         /// <summary>
         /// Called after all output changes occur and right before the output is bound into its final format.
         /// </summary>
-        void PostBackendDecompile(IDecompileResult result);
+        void PostDecompile(IWindowsInstallerDecompileResult result);
     }
 }
diff --git a/src/api/wix/WixToolset.Extensibility/Services/ICommandLineParser.cs b/src/api/wix/WixToolset.Extensibility/Services/ICommandLineParser.cs
index cd17f100..efd6600d 100644
--- a/src/api/wix/WixToolset.Extensibility/Services/ICommandLineParser.cs
+++ b/src/api/wix/WixToolset.Extensibility/Services/ICommandLineParser.cs
@@ -5,36 +5,111 @@ namespace WixToolset.Extensibility.Services
     using System.Collections.Generic;
     using WixToolset.Data;
 
-#pragma warning disable 1591 // TODO: add documentation
+    /// <summary>
+    /// Provides the command-line arguments.
+    /// </summary>
     public interface ICommandLineParser
     {
+        /// <summary>
+        /// Gets the argument that caused the error.
+        /// </summary>
         string ErrorArgument { get; }
 
         /// <summary>
         /// Validates that a valid switch (starts with "/" or "-"), and returns a bool indicating its validity
         /// </summary>
-        /// <param name="arg">The string check.</param>
+        /// <param name="argument">The string check.</param>
         /// <returns>True if a valid switch, otherwise false.</returns>
-        bool IsSwitch(string arg);
+        bool IsSwitch(string argument);
 
+        /// <summary>
+        /// Gets the current argument as a file or displays an error.
+        /// </summary>
+        /// <param name="argument">Current argument used in the error message if necessary.</param>
+        /// <param name="fileType">Type of file displayed in the error message if necessary.</param>
+        /// <returns>The fully expanded path if the argument is a file path, otherwise null.</returns>
         string GetArgumentAsFilePathOrError(string argument, string fileType);
 
-        void GetArgumentAsFilePathOrError(string argument, string fileType, IList<string> paths);
+        /// <summary>
+        /// Adds the current argument as a file to the list or displays an error.
+        /// </summary>
+        /// <param name="argument">Current argument used in the error message if necessary.</param>
+        /// <param name="fileType">Type of file displayed in the error message if necessary.</param>
+        /// <param name="paths">List to add the fully expanded path if the argument is a file path.</param>
+        /// <returns>True if the argument is a file path, otherwise false.</returns>
+        bool GetArgumentAsFilePathOrError(string argument, string fileType, IList<string> paths);
 
-        string GetNextArgumentOrError(string commandLineSwitch);
+        /// <summary>
+        /// Gets the next argument or displays error if no argument is available.
+        /// </summary>
+        /// <param name="argument">Current argument used in the error message if necessary.</param>
+        /// <returns>The next argument if present or null</returns>
+        string GetNextArgumentOrError(string argument);
 
-        bool GetNextArgumentOrError(string commandLineSwitch, IList<string> argument);
+        /// <summary>
+        /// Adds the next argument to a list or displays error if no argument is available.
+        /// </summary>
+        /// <param name="argument">Current argument used in the error message if necessary.</param>
+        /// <param name="arguments">List to add the argument to.</param>
+        /// <returns>True if an argument is available, otherwise false.</returns>
+        bool GetNextArgumentOrError(string argument, IList<string> arguments);
 
-        string GetNextArgumentAsDirectoryOrError(string commandLineSwitch);
+        /// <summary>
+        /// Gets the next argument as a directory or displays an error.
+        /// </summary>
+        /// <param name="argument">Current argument used in the error message if necessary.</param>
+        /// <returns>The fully expanded path if the argument is a directory, otherwise null.</returns>
+        string GetNextArgumentAsDirectoryOrError(string argument);
 
-        bool GetNextArgumentAsDirectoryOrError(string commandLineSwitch, IList<string> directories);
+        /// <summary>
+        /// Adds the next argument as a directory to the list or displays an error.
+        /// </summary>
+        /// <param name="argument">Current argument used in the error message if necessary.</param>
+        /// <param name="directories">List to add the fully expanded directory if the argument is a file path.</param>
+        /// <returns>True if the argument is a directory, otherwise false.</returns>
+        bool GetNextArgumentAsDirectoryOrError(string argument, IList<string> directories);
 
-        string GetNextArgumentAsFilePathOrError(string commandLineSwitch);
+        /// <summary>
+        /// Gets the next argument as a file or displays an error.
+        /// </summary>
+        /// <param name="argument">Current argument used in the error message if necessary.</param>
+        /// <returns>The fully expanded path if the argument is a file path, otherwise null.</returns>
+        string GetNextArgumentAsFilePathOrError(string argument);
 
-        bool GetNextArgumentAsFilePathOrError(string commandLineSwitch, string fileType, IList<string> paths);
+        /// <summary>
+        /// Adds the next argument as a file to the list or displays an error.
+        /// </summary>
+        /// <param name="argument">Current argument used in the error message if necessary.</param>
+        /// <param name="fileType">Type of file displayed in the error message if necessary.</param>
+        /// <param name="paths">List to add the fully expanded path if the argument is a file path.</param>
+        /// <returns>True if the argument is a file path, otherwise false.</returns>
+        bool GetNextArgumentAsFilePathOrError(string argument, string fileType, IList<string> paths);
 
+        /// <summary>
+        /// Reports a command line error for the provided argument.
+        /// </summary>
+        /// <param name="argument">Argument that caused the error.</param>
+        /// <param name="message">Message to report.</param>
         void ReportErrorArgument(string argument, Message message = null);
 
-        bool TryGetNextSwitchOrArgument(out string arg);
+        /// <summary>
+        /// Tries to get the next argument.
+        /// </summary>
+        /// <param name="argument">Next argument if available.</param>
+        /// <returns>True if argument is available, otherwise false.</returns>
+        bool TryGetNextSwitchOrArgument(out string argument);
+
+        /// <summary>
+        /// Looks ahead to the next argument without moving to the next argument.
+        /// </summary>
+        /// <returns>Next argument if available, otherwise null.</returns>
+        string PeekNextArgument();
+
+        /// <summary>
+        /// Tries to looks ahead to the next argument without moving to the next argument.
+        /// </summary>
+        /// <param name="argument">Argument found if present.</param>
+        /// <returns>True if argument is found, otherwise false.</returns>
+        bool TryPeekNextArgument(out string argument);
     }
 }