Introduce IResolveExtension and IFileSystemExtension with cleanup

19 files changed, 254 insertions, 188 deletions

diff --git a/src/WixToolset.Extensibility/BaseResolverExtension.cs b/src/WixToolset.Extensibility/BaseResolverExtension.cs
new file mode 100644
index 00000000..9498d126
--- /dev/null
+++ b/src/WixToolset.Extensibility/BaseResolverExtension.cs
@@ -0,0 +1,38 @@
+// 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.Data;
+    using WixToolset.Data.Bind;
+
+    /// <summary>
+    /// Base class for creating a resolver extension.
+    /// </summary>
+    public abstract class BaseResolverExtension : IResolverExtension
+    {
+        /// <summary>
+        /// Context for use by the extension.
+        /// </summary>
+        protected IResolveContext Context { get; private set; }
+
+        /// <summary>
+        /// Called at the beginning of the resolving variables and files.
+        /// </summary>
+        public virtual void PreResolve(IResolveContext context)
+        {
+            this.Context = context;
+        }
+
+        public virtual string ResolveFile(string source, IntermediateTupleDefinition tupleDefinition, SourceLineNumber sourceLineNumbers, BindStage bindStage)
+        {
+            return null;
+        }
+
+        /// <summary>
+        /// Called at the end of resolve.
+        /// </summary>
+        public virtual void PostResolve(ResolveResult result)
+        {
+        }
+    }
+}
diff --git a/src/WixToolset.Extensibility/BinderExtensionBase.cs b/src/WixToolset.Extensibility/BinderExtensionBase.cs
deleted file mode 100644
index f3f3d63b..00000000
--- a/src/WixToolset.Extensibility/BinderExtensionBase.cs
+++ /dev/null
@@ -1,55 +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.Data;
-    using WixToolset.Data.Bind;
-    using WixToolset.Extensibility.Services;
-
-    public abstract class BinderExtensionBase : IBinderExtension
-    {
-        protected IBindContext Context { get; private set; }
-
-        /// <summary>
-        /// Called before binding occurs.
-        /// </summary>
-        public virtual void PreBind(IBindContext context)
-        {
-            this.Context = context;
-        }
-
-        /// <summary>
-        /// Called after variable resolution occurs.
-        /// </summary>
-        public virtual void AfterResolvedFields(Intermediate intermediate)
-        {
-        }
-
-        public virtual string ResolveFile(string source, string type, SourceLineNumber sourceLineNumbers, BindStage bindStage)
-        {
-            return null;
-        }
-
-        public virtual bool? CompareFiles(string targetFile, string updatedFile)
-        {
-            return null;
-        }
-
-        public virtual bool CopyFile(string source, string destination, bool overwrite)
-        {
-            return false;
-        }
-
-        public virtual bool MoveFile(string source, string destination, bool overwrite)
-        {
-            return false;
-        }
-
-        /// <summary>
-        /// Called after binding is complete before the files are moved to their final locations.
-        /// </summary>
-        public virtual void PostBind(BindResult result)
-        {
-        }
-    }
-}
diff --git a/src/WixToolset.Extensibility/IBackend.cs b/src/WixToolset.Extensibility/IBackend.cs
index 9b950364..385fd086 100644
--- a/src/WixToolset.Extensibility/IBackend.cs
+++ b/src/WixToolset.Extensibility/IBackend.cs
@@ -4,7 +4,6 @@ namespace WixToolset.Extensibility
 {
     using WixToolset.Data;
     using WixToolset.Data.Bind;
-    using WixToolset.Extensibility.Services;
 
     public interface IBackend
     {
diff --git a/src/WixToolset.Extensibility/Services/IBindContext.cs b/src/WixToolset.Extensibility/IBindContext.cs
index ad1aa818..1cb1c558 100644
--- a/src/WixToolset.Extensibility/Services/IBindContext.cs
+++ b/src/WixToolset.Extensibility/IBindContext.cs
@@ -1,10 +1,11 @@
 // 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
+namespace WixToolset.Extensibility
 {
     using System;
     using System.Collections.Generic;
     using WixToolset.Data;
+    using WixToolset.Extensibility.Services;
 
     public interface IBindContext
     {
@@ -12,8 +13,6 @@ namespace WixToolset.Extensibility.Services
 
         IMessaging Messaging { get; set; }
 
-        IEnumerable<BindPath> BindPaths { get; set; }
-
         int CabbingThreadCount { get; set; }
 
         string CabCachePath { get; set; }
@@ -26,9 +25,7 @@ namespace WixToolset.Extensibility.Services
 
         IEnumerable<IExpectedExtractFile> ExpectedEmbeddedFiles { get; set; }
 
-        IExtensionManager ExtensionManager { get; set; }
-
-        IEnumerable<IBinderExtension> Extensions { get; set; }
+        IEnumerable<IFileSystemExtension> FileSystemExtensions { get; set; }
 
         IEnumerable<string> Ices { get; set; }
 
@@ -40,14 +37,10 @@ namespace WixToolset.Extensibility.Services
 
         string OutputPdbPath { get; set; }
 
-        bool SuppressAclReset { get; set; }
-
         IEnumerable<string> SuppressIces { get; set; }
 
         bool SuppressValidation { get; set; }
 
-        IBindVariableResolver WixVariableResolver { get; set; }
-
         string ContentsFile { get; set; }
 
         string OutputsFile { get; set; }
diff --git a/src/WixToolset.Extensibility/IBindVariableResolver.cs b/src/WixToolset.Extensibility/IBindVariableResolver.cs
deleted file mode 100644
index f584f327..00000000
--- a/src/WixToolset.Extensibility/IBindVariableResolver.cs
+++ /dev/null
@@ -1,26 +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.Data;
-    using WixToolset.Data.Tuples;
-
-    public interface IBindVariableResolver
-    {
-        int VariableCount { get; }
-
-        void AddVariable(string name, string value);
-
-        void AddVariable(WixVariableTuple wixVariableRow);
-
-        string ResolveVariables(SourceLineNumber sourceLineNumbers, string value, bool localizationOnly);
-
-        string ResolveVariables(SourceLineNumber sourceLineNumbers, string value, bool localizationOnly, bool errorOnUnknown, out bool isDefault, out bool delayedResolve);
-
-        string ResolveVariables(SourceLineNumber sourceLineNumbers, string value, bool localizationOnly, out bool isDefault);
-
-        string ResolveVariables(SourceLineNumber sourceLineNumbers, string value, bool localizationOnly, out bool isDefault, out bool delayedResolve);
-
-        bool TryGetLocalizedControl(string dialog, string control, out LocalizedControl localizedControl);
-    }
-}
diff --git a/src/WixToolset.Extensibility/IBinderExtension.cs b/src/WixToolset.Extensibility/IBinderExtension.cs
deleted file mode 100644
index 0e9df10b..00000000
--- a/src/WixToolset.Extensibility/IBinderExtension.cs
+++ /dev/null
@@ -1,37 +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.Data;
-    using WixToolset.Data.Bind;
-    using WixToolset.Extensibility.Services;
-
-    /// <summary>
-    /// Interface all binder extensions implement.
-    /// </summary>
-    public interface IBinderExtension
-    {
-        /// <summary>
-        /// Called before binding occurs.
-        /// </summary>
-        void PreBind(IBindContext context);
-
-        /// <summary>
-        /// Called after variable resolution occurs.
-        /// </summary>
-        void AfterResolvedFields(Intermediate intermediate);
-
-        string ResolveFile(string source, string type, SourceLineNumber sourceLineNumbers, BindStage bindStage);
-
-        bool? CompareFiles(string targetFile, string updatedFile);
-
-        bool CopyFile(string source, string destination, bool overwrite);
-
-        bool MoveFile(string source, string destination, bool overwrite);
-
-        /// <summary>
-        /// Called after all output changes occur and right before the output is bound into its final format.
-        /// </summary>
-        void PostBind(BindResult result);
-    }
-}
diff --git a/src/WixToolset.Extensibility/IBinderFileManagerCore.cs b/src/WixToolset.Extensibility/IBinderFileManagerCore.cs
deleted file mode 100644
index 27644413..00000000
--- a/src/WixToolset.Extensibility/IBinderFileManagerCore.cs
+++ /dev/null
@@ -1,55 +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.Collections.Generic;
-    using WixToolset.Data;
-    using WixToolset.Data.Bind;
-
-    public interface IBinderFileManagerCore
-    {
-        /// <summary>
-        /// Gets or sets the path to cabinet cache.
-        /// </summary>
-        /// <value>The path to cabinet cache.</value>
-        string CabCachePath { get; }
-
-        /// <summary>
-        /// Gets or sets the active subStorage used for binding.
-        /// </summary>
-        /// <value>The subStorage object.</value>
-        //SubStorage ActiveSubStorage { get; }
-
-        /// <summary>
-        /// Gets or sets the output object used for binding.
-        /// </summary>
-        /// <value>The output object.</value>
-        Intermediate Intermediate { get; }
-
-        /// <summary>
-        /// Gets or sets the path to the temp files location.
-        /// </summary>
-        /// <value>The path to the temp files location.</value>
-        string TempFilesLocation { get; }
-
-        /// <summary>
-        /// Gets the property if re-basing target is true or false
-        /// </summary>
-        /// <value>It returns true if target bind path is to be replaced, otherwise false.</value>
-        bool RebaseTarget { get; }
-
-        /// <summary>
-        /// Gets the property if re-basing updated build is true or false
-        /// </summary>
-        /// <value>It returns true if updated bind path is to be replaced, otherwise false.</value>
-        bool RebaseUpdated { get; }
-
-        /// <summary>
-        /// Gets the collection of paths to locate files during ResolveFile for the provided BindStage and name.
-        /// </summary>
-        /// <param name="stage">Optional stage to get bind paths for. Default is normal.</param>
-        /// <param name="name">Optional name of the bind paths to get. Default is the unnamed paths.</param>
-        /// <value>The bind paths to locate files.</value>
-        IEnumerable<string> GetBindPaths(BindStage stage = BindStage.Normal, string name = null);
-    }
-}
diff --git a/src/WixToolset.Extensibility/IFileSystemContext.cs b/src/WixToolset.Extensibility/IFileSystemContext.cs
new file mode 100644
index 00000000..32783957
--- /dev/null
+++ b/src/WixToolset.Extensibility/IFileSystemContext.cs
@@ -0,0 +1,25 @@
+// 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 WixToolset.Data;
+    using WixToolset.Extensibility.Services;
+
+    public interface IFileSystemContext
+    {
+        IServiceProvider ServiceProvider { get; }
+
+        IMessaging Messaging { get; set; }
+
+        string CabCachePath { get; set; }
+
+        string IntermediateFolder { get; set; }
+
+        Intermediate IntermediateRepresentation { get; set; }
+
+        string OutputPath { get; set; }
+
+        string OutputPdbPath { get; set; }
+    }
+}
diff --git a/src/WixToolset.Extensibility/IFileSystemExtension.cs b/src/WixToolset.Extensibility/IFileSystemExtension.cs
new file mode 100644
index 00000000..37b8e24a
--- /dev/null
+++ b/src/WixToolset.Extensibility/IFileSystemExtension.cs
@@ -0,0 +1,18 @@
+// 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
+{
+    /// <summary>
+    /// Interface all file system extensions implement.
+    /// </summary>
+    public interface IFileSystemExtension
+    {
+        void Initialize(IFileSystemContext context);
+
+        bool? CompareFiles(string targetFile, string updatedFile);
+
+        bool CopyFile(string source, string destination, bool overwrite);
+
+        bool MoveFile(string source, string destination, bool overwrite);
+    }
+}
diff --git a/src/WixToolset.Extensibility/ILayoutContext.cs b/src/WixToolset.Extensibility/ILayoutContext.cs
new file mode 100644
index 00000000..5b4f014d
--- /dev/null
+++ b/src/WixToolset.Extensibility/ILayoutContext.cs
@@ -0,0 +1,34 @@
+// 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.Collections.Generic;
+    using WixToolset.Data.Bind;
+    using WixToolset.Extensibility.Services;
+
+    public interface ILayoutContext
+    {
+        IServiceProvider ServiceProvider { get; }
+
+        IMessaging Messaging { get; set; }
+
+        IEnumerable<ILayoutExtension> Extensions { get; set; }
+
+        IEnumerable<IFileSystemExtension> FileSystemExtensions { get; set; }
+
+        IEnumerable<string> ContentFilePaths { get; set; }
+
+        IEnumerable<FileTransfer> FileTransfers { get; set; }
+
+        string OutputPdbPath { get; set; }
+
+        string ContentsFile { get; set; }
+
+        string OutputsFile { get; set; }
+
+        string BuiltOutputsFile { get; set; }
+
+        bool SuppressAclReset { get; set; }
+    }
+}
diff --git a/src/WixToolset.Extensibility/ILayoutExtension.cs b/src/WixToolset.Extensibility/ILayoutExtension.cs
new file mode 100644
index 00000000..b1de5bd2
--- /dev/null
+++ b/src/WixToolset.Extensibility/ILayoutExtension.cs
@@ -0,0 +1,20 @@
+// 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
+{
+    /// <summary>
+    /// Interface all resolver extensions implement.
+    /// </summary>
+    public interface ILayoutExtension
+    {
+        /// <summary>
+        /// Called before resolving occurs.
+        /// </summary>
+        void PreLayout(ILayoutContext context);
+
+        /// <summary>
+        /// Called after all resolving occurs.
+        /// </summary>
+        void PostLayout();
+    }
+}
diff --git a/src/WixToolset.Extensibility/ILibrarianExtension.cs b/src/WixToolset.Extensibility/ILibrarianExtension.cs
index ae4529d8..381abf01 100644
--- a/src/WixToolset.Extensibility/ILibrarianExtension.cs
+++ b/src/WixToolset.Extensibility/ILibrarianExtension.cs
@@ -8,7 +8,7 @@ namespace WixToolset.Extensibility
     {
         void PreCombine(ILibraryContext context);
 
-        string Resolve(SourceLineNumber sourceLineNumber, string table, string path);
+        string Resolve(SourceLineNumber sourceLineNumber, IntermediateTupleDefinition tupleDefinition, string path);
 
         void PostCombine(Intermediate library);
     }
diff --git a/src/WixToolset.Extensibility/ILibraryContext.cs b/src/WixToolset.Extensibility/ILibraryContext.cs
index e715080f..0c29a3dd 100644
--- a/src/WixToolset.Extensibility/ILibraryContext.cs
+++ b/src/WixToolset.Extensibility/ILibraryContext.cs
@@ -24,7 +24,5 @@ namespace WixToolset.Extensibility
         IEnumerable<Localization> Localizations { get; set; }
 
         IEnumerable<Intermediate> Intermediates { get; set; }
-
-        IBindVariableResolver WixVariableResolver { get; set; }
     }
 }
diff --git a/src/WixToolset.Extensibility/Services/ILinkContext.cs b/src/WixToolset.Extensibility/ILinkContext.cs
index e098a900..65eeb6f1 100644
--- a/src/WixToolset.Extensibility/Services/ILinkContext.cs
+++ b/src/WixToolset.Extensibility/ILinkContext.cs
@@ -1,10 +1,11 @@
 // 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
+namespace WixToolset.Extensibility
 {
     using System;
     using System.Collections.Generic;
     using WixToolset.Data;
+    using WixToolset.Extensibility.Services;
 
     public interface ILinkContext
     {
diff --git a/src/WixToolset.Extensibility/IResolveContext.cs b/src/WixToolset.Extensibility/IResolveContext.cs
new file mode 100644
index 00000000..026e5a35
--- /dev/null
+++ b/src/WixToolset.Extensibility/IResolveContext.cs
@@ -0,0 +1,26 @@
+// 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.Collections.Generic;
+    using WixToolset.Data;
+    using WixToolset.Extensibility.Services;
+
+    public interface IResolveContext
+    {
+        IServiceProvider ServiceProvider { get; }
+
+        IMessaging Messaging { get; set; }
+
+        IEnumerable<BindPath> BindPaths { get; set; }
+
+        IEnumerable<IResolverExtension> Extensions { get; set; }
+
+        string IntermediateFolder { get; set; }
+
+        Intermediate IntermediateRepresentation { get; set; }
+
+        IBindVariableResolver WixVariableResolver { get; set; }
+    }
+}
diff --git a/src/WixToolset.Extensibility/IResolverExtension.cs b/src/WixToolset.Extensibility/IResolverExtension.cs
new file mode 100644
index 00000000..b0478ff0
--- /dev/null
+++ b/src/WixToolset.Extensibility/IResolverExtension.cs
@@ -0,0 +1,25 @@
+// 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.Data;
+    using WixToolset.Data.Bind;
+
+    /// <summary>
+    /// Interface all resolver extensions implement.
+    /// </summary>
+    public interface IResolverExtension
+    {
+        /// <summary>
+        /// Called before resolving occurs.
+        /// </summary>
+        void PreResolve(IResolveContext context);
+
+        string ResolveFile(string source, IntermediateTupleDefinition tupleDefinition, SourceLineNumber sourceLineNumbers, BindStage bindStage);
+
+        /// <summary>
+        /// Called after all resolving occurs.
+        /// </summary>
+        void PostResolve(ResolveResult result);
+    }
+}
diff --git a/src/WixToolset.Extensibility/ResolveResult.cs b/src/WixToolset.Extensibility/ResolveResult.cs
new file mode 100644
index 00000000..14073ab0
--- /dev/null
+++ b/src/WixToolset.Extensibility/ResolveResult.cs
@@ -0,0 +1,18 @@
+// 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;
+
+    public class ResolveResult
+    {
+        public int Codepage { get; set; }
+
+        public IEnumerable<IExpectedExtractFile> ExpectedEmbeddedFiles { get; set; }
+
+        public IEnumerable<IDelayedField> DelayedFields { get; set; }
+
+        public Intermediate IntermediateRepresentation { get; set; }
+    }
+}
\ No newline at end of file
diff --git a/src/WixToolset.Extensibility/Services/BindVariableResolution.cs b/src/WixToolset.Extensibility/Services/BindVariableResolution.cs
new file mode 100644
index 00000000..cdd1fa19
--- /dev/null
+++ b/src/WixToolset.Extensibility/Services/BindVariableResolution.cs
@@ -0,0 +1,27 @@
+// 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
+{
+    public class BindVariableResolution
+    {
+        /// <summary>
+        /// Indicates whether the variable should be delay resolved.
+        /// </summary>
+        public bool DelayedResolve { get; set; }
+
+        /// <summary>
+        /// Indicates whether the value is the default value of the variable.
+        /// </summary>
+        public bool IsDefault { get; set; }
+
+        /// <summary>
+        /// Indicates whether the value changed.
+        /// </summary>
+        public bool UpdatedValue { get; set; }
+
+        /// <summary>
+        /// Resolved value.
+        /// </summary>
+        public string Value { get; set; }
+    }
+}
\ No newline at end of file
diff --git a/src/WixToolset.Extensibility/Services/IBindVariableResolver.cs b/src/WixToolset.Extensibility/Services/IBindVariableResolver.cs
new file mode 100644
index 00000000..50071658
--- /dev/null
+++ b/src/WixToolset.Extensibility/Services/IBindVariableResolver.cs
@@ -0,0 +1,17 @@
+// 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;
+
+    public interface IBindVariableResolver
+    {
+        int VariableCount { get; }
+
+        void AddVariable(string name, string value, bool overridable);
+
+        BindVariableResolution ResolveVariables(SourceLineNumber sourceLineNumbers, string value, bool localizationOnly);
+
+        bool TryGetLocalizedControl(string dialog, string control, out LocalizedControl localizedControl);
+    }
+}