Enable MSI backends to add custom tables from tuples

6 files changed, 73 insertions, 80 deletions

diff --git a/src/WixToolset.Extensibility/BasePreprocessorExtension.cs b/src/WixToolset.Extensibility/BasePreprocessorExtension.cs
index acfcd5b9..f5d89103 100644
--- a/src/WixToolset.Extensibility/BasePreprocessorExtension.cs
+++ b/src/WixToolset.Extensibility/BasePreprocessorExtension.cs
@@ -16,7 +16,7 @@ namespace WixToolset.Extensibility
         protected IPreprocessContext Context { get; private set; }
 
         /// <summary>
-        /// ParserHelper for use by the extension.
+        /// PreprocessHelper for use by the extension.
         /// </summary>
         protected IPreprocessHelper PreprocessHelper { get; private set; }
 
diff --git a/src/WixToolset.Extensibility/BaseWindowsInstallerBackendExtension.cs b/src/WixToolset.Extensibility/BaseWindowsInstallerBackendExtension.cs
new file mode 100644
index 00000000..0bcfce01
--- /dev/null
+++ b/src/WixToolset.Extensibility/BaseWindowsInstallerBackendExtension.cs
@@ -0,0 +1,53 @@
+// 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 System.Collections.Generic;
+    using WixToolset.Data;
+    using WixToolset.Data.Bind;
+    using WixToolset.Data.Tuples;
+    using WixToolset.Data.WindowsInstaller;
+    using WixToolset.Extensibility.Services;
+
+    /// <summary>
+    /// Base class for creating a preprocessor extension.
+    /// </summary>
+    public abstract class BaseWindowsInstallerBackendExtension : IWindowsInstallerBackendExtension
+    {
+        /// <summary>
+        /// Context for use by the extension.
+        /// </summary>
+        protected IBindContext Context { get; private set; }
+
+        /// <summary>
+        /// Backend helper for use by the extension.
+        /// </summary>
+        protected IWindowsInstallerBackendHelper BackendHelper { get; private set; }
+
+        public virtual void PreBackendBind(IBindContext context)
+        {
+            this.Context = context;
+
+            this.BackendHelper = context.ServiceProvider.GetService<IWindowsInstallerBackendHelper>();
+        }
+
+        public virtual ResolvedCabinet ResolveCabinet(string cabinetPath, IEnumerable<BindFileWithPath> files)
+        {
+            return null;
+        }
+
+        public virtual string ResolveMedia(MediaTuple mediaRow, string mediaLayoutDirectory, string layoutDirectory)
+        {
+            return null;
+        }
+
+        public virtual bool TryAddTupleToOutput(IntermediateTuple tuple, Output output)
+        {
+            return false;
+        }
+
+        public virtual void PostBackendBind(BindResult result)
+        {
+        }
+    }
+}
diff --git a/src/WixToolset.Extensibility/ExtensionData.cs b/src/WixToolset.Extensibility/ExtensionData.cs
deleted file mode 100644
index 0cd0c420..00000000
--- a/src/WixToolset.Extensibility/ExtensionData.cs
+++ /dev/null
@@ -1,77 +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 System;
-    using System.IO;
-    using System.Reflection;
-    using System.Xml;
-    using WixToolset.Data;
-
-#if BRING_BACK_LATER
-    public abstract class ExtensionData : IExtensionData
-    {
-        /// <summary>
-        /// Gets the optional table definitions for this extension.
-        /// </summary>
-        /// <value>Table definisions for this extension or null if there are no table definitions.</value>
-        public virtual TableDefinitionCollection TableDefinitions
-        {
-            get { return null; }
-        }
-
-        /// <summary>
-        /// Gets the optional default culture.
-        /// </summary>
-        /// <value>The optional default culture.</value>
-        public virtual string DefaultCulture
-        {
-            get { return null; }
-        }
-
-        /// <summary>
-        /// Gets the optional library associated with this extension.
-        /// </summary>
-        /// <param name="tableDefinitions">The table definitions to use while loading the library.</param>
-        /// <returns>The library for this extension or null if there is no library.</returns>
-        public virtual Library GetLibrary(TableDefinitionCollection tableDefinitions)
-        {
-            return null;
-        }
-
-        /// <summary>
-        /// Help for loading a library from an embedded resource.
-        /// </summary>
-        /// <param name="assembly">The assembly containing the embedded resource.</param>
-        /// <param name="resourceName">The name of the embedded resource being requested.</param>
-        /// <param name="tableDefinitions">The table definitions to use while loading the library.</param>
-        /// <returns>The loaded library.</returns>
-        protected static Library LoadLibraryHelper(Assembly assembly, string resourceName, TableDefinitionCollection tableDefinitions)
-        {
-            using (Stream resourceStream = assembly.GetManifestResourceStream(resourceName))
-            {
-                UriBuilder uriBuilder = new UriBuilder(assembly.CodeBase);
-                uriBuilder.Scheme = "embeddedresource";
-                uriBuilder.Fragment = resourceName;
-
-                return Library.Load(resourceStream, uriBuilder.Uri, tableDefinitions, false);
-            }
-        }
-
-        /// <summary>
-        /// Helper for loading table definitions from an embedded resource.
-        /// </summary>
-        /// <param name="assembly">The assembly containing the embedded resource.</param>
-        /// <param name="resourceName">The name of the embedded resource being requested.</param>
-        /// <returns>The loaded table definitions.</returns>
-        protected static TableDefinitionCollection LoadTableDefinitionHelper(Assembly assembly, string resourceName)
-        {
-            using (Stream resourceStream = assembly.GetManifestResourceStream(resourceName))
-            using (XmlReader reader = XmlReader.Create(resourceStream))
-            {
-                return TableDefinitionCollection.Load(reader);
-            }
-        }
-    }
-#endif
-}
diff --git a/src/WixToolset.Extensibility/IPreprocessorExtension.cs b/src/WixToolset.Extensibility/IPreprocessorExtension.cs
index 8511abbc..68f82693 100644
--- a/src/WixToolset.Extensibility/IPreprocessorExtension.cs
+++ b/src/WixToolset.Extensibility/IPreprocessorExtension.cs
@@ -2,9 +2,7 @@
 
 namespace WixToolset.Extensibility
 {
-    using System;
     using System.Xml.Linq;
-    using WixToolset.Data;
 
     /// <summary>
     /// Interface for extending the WiX toolset preprocessor.
diff --git a/src/WixToolset.Extensibility/IWindowsInstallerBackendExtension.cs b/src/WixToolset.Extensibility/IWindowsInstallerBackendExtension.cs
index f6ffc69c..ed10a077 100644
--- a/src/WixToolset.Extensibility/IWindowsInstallerBackendExtension.cs
+++ b/src/WixToolset.Extensibility/IWindowsInstallerBackendExtension.cs
@@ -3,8 +3,10 @@
 namespace WixToolset.Extensibility
 {
     using System.Collections.Generic;
+    using WixToolset.Data;
     using WixToolset.Data.Bind;
     using WixToolset.Data.Tuples;
+    using WixToolset.Data.WindowsInstaller;
     using WixToolset.Extensibility.Services;
 
     /// <summary>
@@ -21,6 +23,8 @@ namespace WixToolset.Extensibility
 
         string ResolveMedia(MediaTuple mediaRow, string mediaLayoutDirectory, string layoutDirectory);
 
+        bool TryAddTupleToOutput(IntermediateTuple tuple, Output output);
+
         /// <summary>
         /// Called after all output changes occur and right before the output is bound into its final format.
         /// </summary>
diff --git a/src/WixToolset.Extensibility/Services/IWindowsInstallerBackendHelper.cs b/src/WixToolset.Extensibility/Services/IWindowsInstallerBackendHelper.cs
new file mode 100644
index 00000000..2de455fd
--- /dev/null
+++ b/src/WixToolset.Extensibility/Services/IWindowsInstallerBackendHelper.cs
@@ -0,0 +1,15 @@
+// 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.Services
+{
+    using WixToolset.Data;
+    using WixToolset.Data.WindowsInstaller;
+
+    /// <summary>
+    /// Interface provided to help Windows Installer backend extensions.
+    /// </summary>
+    public interface IWindowsInstallerBackendHelper
+    {
+        bool TryAddTupleToOutputMatchingTableDefinitions(IntermediateTuple tuple, Output output, TableDefinition[] tableDefinitions);
+    }
+}