Fix IExtensionCommandLine and IPreprocessorExtension

11 files changed, 184 insertions, 92 deletions

diff --git a/src/Directory.Build.props b/src/Directory.Build.props
index 25cb6d36..7cd6767f 100644
--- a/src/Directory.Build.props
+++ b/src/Directory.Build.props
@@ -5,11 +5,13 @@
   <PropertyGroup>
     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
     <BaseIntermediateOutputPath>$(MSBuildThisFileDirectory)..\build\obj\$(MSBuildProjectName)\</BaseIntermediateOutputPath>
-    <OutputPath>$(MSBuildThisFileDirectory)..\build\$(Configuration)\</OutputPath>
+    <BaseOutputPath>$(MSBuildThisFileDirectory)..\build\$(Configuration)\</BaseOutputPath>
+    <OutputPath>$(BaseOutputPath)</OutputPath>
 
     <Authors>WiX Toolset Team</Authors>
     <Company>WiX Toolset</Company>
     <Copyright>Copyright (c) .NET Foundation and contributors. All rights reserved.</Copyright>
+    <Product>WiX Toolset</Product>
   </PropertyGroup>
 
   <PropertyGroup>
diff --git a/src/WixToolset.Extensibility/BaseCompilerExtension.cs b/src/WixToolset.Extensibility/BaseCompilerExtension.cs
index 508886d3..5dfe5dcf 100644
--- a/src/WixToolset.Extensibility/BaseCompilerExtension.cs
+++ b/src/WixToolset.Extensibility/BaseCompilerExtension.cs
@@ -13,6 +13,11 @@ namespace WixToolset.Extensibility
     public abstract class BaseCompilerExtension : ICompilerExtension
     {
         /// <summary>
+        /// Messaging for use by the extension.
+        /// </summary>
+        protected Messaging Messaging { get; private set; }
+
+        /// <summary>
         /// ParserHelper for use by the extension.
         /// </summary>
         protected IParseHelper ParseHelper { get; private set; }
@@ -28,6 +33,8 @@ namespace WixToolset.Extensibility
         /// </summary>
         public virtual void PreCompile(ICompileContext context)
         {
+            this.Messaging = context.Messaging;
+
             this.ParseHelper = context.ServiceProvider.GetService<IParseHelper>();
         }
 
diff --git a/src/WixToolset.Extensibility/PreprocessorExtension.cs b/src/WixToolset.Extensibility/BasePreprocessorExtension.cs
index 2af30a95..acfcd5b9 100644
--- a/src/WixToolset.Extensibility/PreprocessorExtension.cs
+++ b/src/WixToolset.Extensibility/BasePreprocessorExtension.cs
@@ -3,33 +3,37 @@
 namespace WixToolset.Extensibility
 {
     using System.Xml.Linq;
-    using WixToolset.Data;
+    using WixToolset.Extensibility.Services;
 
     /// <summary>
     /// Base class for creating a preprocessor extension.
     /// </summary>
-    public abstract class PreprocessorExtension : IPreprocessorExtension
+    public abstract class BasePreprocessorExtension : IPreprocessorExtension
     {
         /// <summary>
-        /// Gets or sets the preprocessor core for the extension.
+        /// Context for use by the extension.
         /// </summary>
-        /// <value>Preprocessor core for the extension.</value>
-        public IPreprocessorCore Core { get; set; }
+        protected IPreprocessContext Context { get; private set; }
+
+        /// <summary>
+        /// ParserHelper for use by the extension.
+        /// </summary>
+        protected IPreprocessHelper PreprocessHelper { get; private set; }
 
         /// <summary>
         /// Gets or sets the variable prefixes for the extension.
         /// </summary>
         /// <value>The variable prefixes for the extension.</value>
-        public virtual string[] Prefixes
-        {
-            get { return null; }
-        }
+        public string[] Prefixes { get; protected set; }
 
         /// <summary>
         /// Called at the beginning of the preprocessing of a source file.
         /// </summary>
-        public virtual void Initialize()
+        public virtual void PrePreprocess(IPreprocessContext context)
         {
+            this.Context = context;
+
+            this.PreprocessHelper = context.ServiceProvider.GetService<IPreprocessHelper>();
         }
 
         /// <summary>
@@ -65,34 +69,15 @@ namespace WixToolset.Extensibility
         /// <param name="parent">The parent node of the pragma.</param>
         /// <returns>false if the pragma is not defined.</returns>
         /// <comments>Don't return false for any condition except for unrecognized pragmas. Throw errors that are fatal to the compile. use core.OnMessage for warnings and messages.</comments>
-        public virtual bool ProcessPragma(SourceLineNumber sourceLineNumbers, string prefix, string pragma, string args, XContainer parent)
+        public virtual bool ProcessPragma(string prefix, string pragma, string args, XContainer parent)
         {
             return false;
         }
 
         /// <summary>
-        /// Preprocess a document after normal preprocessing has completed.
-        /// </summary>
-        /// <param name="document">The document to preprocess.</param>
-        public virtual void PreprocessDocument(XDocument document)
-        {
-        }
-
-        /// <summary>
-        /// Preprocesses a parameter.
-        /// </summary>
-        /// <param name="name">Name of parameter that matches extension.</param>
-        /// <returns>The value of the parameter after processing.</returns>
-        /// <remarks>By default this method will cause an error if its called.</remarks>
-        public virtual string PreprocessParameter(string name)
-        {
-            return null;
-        }
-
-        /// <summary>
         /// Called at the end of the preprocessing of a source file.
         /// </summary>
-        public virtual void Finish()
+        public virtual void PostPreprocess(XDocument document)
         {
         }
     }
diff --git a/src/WixToolset.Extensibility/IExtensionCommandLine.cs b/src/WixToolset.Extensibility/IExtensionCommandLine.cs
index b6cff5d0..1f8e6ed8 100644
--- a/src/WixToolset.Extensibility/IExtensionCommandLine.cs
+++ b/src/WixToolset.Extensibility/IExtensionCommandLine.cs
@@ -3,7 +3,7 @@
 namespace WixToolset.Extensibility
 {
     using System.Collections.Generic;
-    using WixToolset.Data;
+    using WixToolset.Extensibility.Services;
 
     /// <summary>
     /// A command line option.
@@ -21,22 +21,13 @@ namespace WixToolset.Extensibility
     public interface IExtensionCommandLine
     {
         /// <summary>
-        /// Sets the message handler for the extension.
-        /// </summary>
-        /// <value>Message handler for the extension.</value>
-        IMessageHandler MessageHandler { set; }
-
-        /// <summary>
         /// Gets the supported command line types for this extension.
         /// </summary>
         /// <value>The supported command line types for this extension.</value>
         IEnumerable<ExtensionCommandLineSwitch> CommandLineSwitches { get; }
 
-        /// <summary>
-        /// Parse the commandline arguments.
-        /// </summary>
-        /// <param name="args">Commandline arguments.</param>
-        /// <returns>Unparsed commandline arguments.</returns>
-        string[] ParseCommandLine(string[] args);
+        void PreParse(ICommandLineContext context);
+
+        bool TryParseArgument(IParseCommandLine parseCommandLine, string arg);
     }
 }
diff --git a/src/WixToolset.Extensibility/IExtensionData.cs b/src/WixToolset.Extensibility/IExtensionData.cs
index f0e339d4..1721a76c 100644
--- a/src/WixToolset.Extensibility/IExtensionData.cs
+++ b/src/WixToolset.Extensibility/IExtensionData.cs
@@ -26,8 +26,8 @@ namespace WixToolset.Extensibility
         /// <summary>
         /// Gets the library associated with this extension.
         /// </summary>
-        /// <param name="tableDefinitions">The table definitions to use while loading the library.</param>
+        /// <param name="tupleDefinitions">The tuple definitions to use while loading the library.</param>
         /// <returns>The library for this extension or null if there is no library.</returns>
-        Library GetLibrary(ITupleDefinitionCreator tupleDefinitions);
+        Intermediate GetLibrary(ITupleDefinitionCreator tupleDefinitions);
     }
 }
diff --git a/src/WixToolset.Extensibility/IPreprocessContext.cs b/src/WixToolset.Extensibility/IPreprocessContext.cs
new file mode 100644
index 00000000..0f9c90bf
--- /dev/null
+++ b/src/WixToolset.Extensibility/IPreprocessContext.cs
@@ -0,0 +1,31 @@
+// 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;
+
+    public interface IPreprocessContext
+    {
+        IServiceProvider ServiceProvider { get; }
+
+        Messaging Messaging { get; set; }
+
+        IEnumerable<IPreprocessorExtension> Extensions { get; set; }
+
+        /// <summary>
+        /// Gets the platform which the compiler will use when defaulting 64-bit attributes and elements.
+        /// </summary>
+        /// <value>The platform which the compiler will use when defaulting 64-bit attributes and elements.</value>
+        Platform Platform { get; set; }
+
+        IList<string> IncludeSearchPaths { get; set; }
+
+        string SourceFile { get; set; }
+
+        IDictionary<string, string> Variables { get; set; }
+
+        SourceLineNumber CurrentSourceLineNumber { get; set; }
+    }
+}
diff --git a/src/WixToolset.Extensibility/IPreprocessorCore.cs b/src/WixToolset.Extensibility/IPreprocessorCore.cs
deleted file mode 100644
index a0449139..00000000
--- a/src/WixToolset.Extensibility/IPreprocessorCore.cs
+++ /dev/null
@@ -1,21 +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;
-
-    public interface IPreprocessorCore : IMessageHandler
-    {
-        /// <summary>
-        /// Gets or sets the platform which the compiler will use when defaulting 64-bit attributes and elements.
-        /// </summary>
-        /// <value>The platform which the compiler will use when defaulting 64-bit attributes and elements.</value>
-        Platform CurrentPlatform { get; }
-
-        /// <summary>
-        /// Gets whether the core encountered an error while processing.
-        /// </summary>
-        /// <value>Flag if core encountered an error during processing.</value>
-        bool EncounteredError { get; }
-    }
-}
diff --git a/src/WixToolset.Extensibility/IPreprocessorExtension.cs b/src/WixToolset.Extensibility/IPreprocessorExtension.cs
index de415526..8511abbc 100644
--- a/src/WixToolset.Extensibility/IPreprocessorExtension.cs
+++ b/src/WixToolset.Extensibility/IPreprocessorExtension.cs
@@ -12,12 +12,6 @@ namespace WixToolset.Extensibility
     public interface IPreprocessorExtension
     {
         /// <summary>
-        /// Gets or sets the preprocessor core for the extension.
-        /// </summary>
-        /// <value>Preprocessor core for the extension.</value>
-        IPreprocessorCore Core { get; set; }
-
-        /// <summary>
         /// Gets the variable prefixes for the extension.
         /// </summary>
         /// <value>The variable prefixes for the extension.</value>
@@ -26,7 +20,7 @@ namespace WixToolset.Extensibility
         /// <summary>
         /// Called at the beginning of the preprocessing of a source file.
         /// </summary>
-        void Initialize();
+        void PrePreprocess(IPreprocessContext context);
 
         /// <summary>
         /// Gets the value of a variable whose prefix matches the extension.
@@ -55,25 +49,11 @@ namespace WixToolset.Extensibility
         /// <param name="parent">The parent node of the pragma.</param>
         /// <returns>false if the pragma is not defined.</returns>
         /// <comments>Don't return false for any condition except for unrecognized pragmas. Use Core.OnMessage for errors, warnings and messages.</comments>
-        bool ProcessPragma(SourceLineNumber sourceLineNumbers, string prefix, string pragma, string args, XContainer parent);
-
-        /// <summary>
-        /// Preprocess a document after normal preprocessing has completed.
-        /// </summary>
-        /// <param name="document">The document to preprocess.</param>
-        void PreprocessDocument(XDocument document);
-
-        /// <summary>
-        /// Preprocesses a parameter.
-        /// </summary>
-        /// <param name="name">Name of parameter that matches extension.</param>
-        /// <returns>The value of the parameter after processing.</returns>
-        /// <remarks>By default this method will cause an error if its called.</remarks>
-        string PreprocessParameter(string name);
+        bool ProcessPragma(string prefix, string pragma, string args, XContainer parent);
 
         /// <summary>
         /// Called at the end of the preprocessing of a source file.
         /// </summary>
-        void Finish();
+        void PostPreprocess(XDocument document);
     }
 }
diff --git a/src/WixToolset.Extensibility/Services/IParseCommandLine.cs b/src/WixToolset.Extensibility/Services/IParseCommandLine.cs
new file mode 100644
index 00000000..1b23be14
--- /dev/null
+++ b/src/WixToolset.Extensibility/Services/IParseCommandLine.cs
@@ -0,0 +1,21 @@
+// 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 System.Collections.Generic;
+
+    public interface IParseCommandLine
+    {
+        bool IsSwitch(string arg);
+
+        bool IsSwitchAt(IEnumerable<string> args, int index);
+
+        void GetNextArgumentOrError(ref string arg);
+
+        void GetNextArgumentOrError(IList<string> args);
+
+        void GetNextArgumentAsFilePathOrError(IList<string> args, string fileType);
+
+        bool TryGetNextArgumentOrError(out string arg);
+    }
+}
diff --git a/src/WixToolset.Extensibility/Services/IParseHelper.cs b/src/WixToolset.Extensibility/Services/IParseHelper.cs
index 46ade2e1..ad15c063 100644
--- a/src/WixToolset.Extensibility/Services/IParseHelper.cs
+++ b/src/WixToolset.Extensibility/Services/IParseHelper.cs
@@ -8,7 +8,7 @@ namespace WixToolset.Extensibility.Services
     using WixToolset.Data;
 
     /// <summary>
-    /// Core interface provided by the compiler.
+    /// Interface provided to help compiler extensions parse.
     /// </summary>
     public interface IParseHelper
     {
@@ -243,6 +243,13 @@ namespace WixToolset.Extensibility.Services
         YesNoDefaultType GetAttributeYesNoDefaultValue(SourceLineNumber sourceLineNumbers, XAttribute attribute);
 
         /// <summary>
+        /// Gets a source line number for an element.
+        /// </summary>
+        /// <param name="element">Element to get source line number.</param>
+        /// <returns>Source line number.</returns>
+        SourceLineNumber GetSourceLineNumbers(XElement element);
+
+        /// <summary>
         /// Gets node's inner text and ensure's it is safe for use in a condition by trimming any extra whitespace.
         /// </summary>
         /// <param name="node">The node to ensure inner text is a condition.</param>
diff --git a/src/WixToolset.Extensibility/Services/IPreprocessHelper.cs b/src/WixToolset.Extensibility/Services/IPreprocessHelper.cs
new file mode 100644
index 00000000..01c55009
--- /dev/null
+++ b/src/WixToolset.Extensibility/Services/IPreprocessHelper.cs
@@ -0,0 +1,89 @@
+// 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 System.Xml.Linq;
+
+    /// <summary>
+    /// Interface provided to help preprocessor extensions.
+    /// </summary>
+    public interface IPreprocessHelper
+    {
+        /// <summary>
+        /// Add a variable.
+        /// </summary>
+        /// <param name="context">The preprocess context.</param>
+        /// <param name="name">The variable name.</param>
+        /// <param name="value">The variable value.</param>
+        void AddVariable(IPreprocessContext context, string name, string value);
+
+        /// <summary>
+        /// Add a variable.
+        /// </summary>
+        /// <param name="context">The preprocess context.</param>
+        /// <param name="name">The variable name.</param>
+        /// <param name="value">The variable value.</param>
+        /// <param name="overwrite">Set to true to show variable overwrite warning.</param>
+        void AddVariable(IPreprocessContext context, string name, string value, bool showWarning);
+
+        /// <summary>
+        /// Evaluate a function.
+        /// </summary>
+        /// <param name="context">The preprocess context.</param>
+        /// <param name="function">The function expression including the prefix and name.</param>
+        /// <returns>The function value.</returns>
+        string EvaluateFunction(IPreprocessContext context, string function);
+
+        /// <summary>
+        /// Evaluate a function.
+        /// </summary>
+        /// <param name="context">The preprocess context.</param>
+        /// <param name="prefix">The function prefix.</param>
+        /// <param name="function">The function name.</param>
+        /// <param name="args">The arguments for the function.</param>
+        /// <returns>The function value or null if the function is not defined.</returns>
+        string EvaluateFunction(IPreprocessContext context, string prefix, string function, string[] args);
+
+        /// <summary>
+        /// Get the value of a variable expression like var.name.
+        /// </summary>
+        /// <param name="context">The preprocess context.</param>
+        /// <param name="variable">The variable expression including the optional prefix and name.</param>
+        /// <param name="allowMissingPrefix">true to allow the variable prefix to be missing.</param>
+        /// <returns>The variable value.</returns>
+        string GetVariableValue(IPreprocessContext context, string variable, bool allowMissingPrefix);
+
+        /// <summary>
+        /// Get the value of a variable.
+        /// </summary>
+        /// <param name="context">The preprocess context.</param>
+        /// <param name="prefix">The variable prefix.</param>
+        /// <param name="name">The variable name.</param>
+        /// <returns>The variable value or null if the variable is not set.</returns>
+        string GetVariableValue(IPreprocessContext context, string prefix, string name);
+
+        /// <summary>
+        /// Evaluate a Pragma.
+        /// </summary>
+        /// <param name="context">The preprocess context.</param>
+        /// <param name="pragmaName">The pragma's full name (<prefix>.<pragma>).</param>
+        /// <param name="args">The arguments to the pragma.</param>
+        /// <param name="parent">The parent element of the pragma.</param>
+        void PreprocessPragma(IPreprocessContext context, string pragmaName, string args, XContainer parent);
+
+        /// <summary>
+        /// Replaces parameters in the source text.
+        /// </summary>
+        /// <param name="context">The preprocess context.</param>
+        /// <param name="value">Text that may contain parameters to replace.</param>
+        /// <returns>Text after parameters have been replaced.</returns>
+        string PreprocessString(IPreprocessContext context, string value);
+
+        /// <summary>
+        /// Remove a variable.
+        /// </summary>
+        /// <param name="context">The preprocess context.</param>
+        /// <param name="name">The variable name.</param>
+        void RemoveVariable(IPreprocessContext context, string name);
+    }
+}