Add support for loading Intermediates from extensions

10 files changed, 282 insertions, 0 deletions

diff --git a/src/test/TestData/Example.Extension/Data/example.txt b/src/test/TestData/Example.Extension/Data/example.txt
new file mode 100644
index 00000000..1b4ffe8a
--- /dev/null
+++ b/src/test/TestData/Example.Extension/Data/example.txt
@@ -0,0 +1 @@
+This is example.txt.
\ No newline at end of file
diff --git a/src/test/TestData/Example.Extension/Data/example.wir b/src/test/TestData/Example.Extension/Data/example.wir
new file mode 100644
index 00000000..674f63fc
--- /dev/null
+++ b/src/test/TestData/Example.Extension/Data/example.wir
diff --git a/src/test/TestData/Example.Extension/Data/example.wxs b/src/test/TestData/Example.Extension/Data/example.wxs
new file mode 100644
index 00000000..53531e99
--- /dev/null
+++ b/src/test/TestData/Example.Extension/Data/example.wxs
@@ -0,0 +1,8 @@
+<?xml version='1.0'?>
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+  <Fragment>
+    <Property Id="PropertyFromExampleWir" Value="FromWir" />
+
+    <Binary Id="BinFromWir" SourceFile="example.txt" />
+  </Fragment>
+</Wix>
diff --git a/src/test/TestData/Example.Extension/Example.Extension.csproj b/src/test/TestData/Example.Extension/Example.Extension.csproj
new file mode 100644
index 00000000..d04ce553
--- /dev/null
+++ b/src/test/TestData/Example.Extension/Example.Extension.csproj
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- 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. -->
+
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <EmbeddedResource Include="Data\Example.wir" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="$(WixToolsetRootFolder)\Data\src\WixToolset.Data\WixToolset.Data.csproj" Condition=" '$(Configuration)' == 'Debug' And Exists('$(WixToolsetRootFolder)\Data\src\WixToolset.Data\WixToolset.Data.csproj') " />
+    <PackageReference Include="WixToolset.Data" Version="4.0.*" Condition=" '$(Configuration)' == 'Release' Or !Exists('$(WixToolsetRootFolder)\Data\src\WixToolset.Data\WixToolset.Data.csproj') " />
+
+    <ProjectReference Include="$(WixToolsetRootFolder)\Extensibility\src\WixToolset.Extensibility\WixToolset.Extensibility.csproj" Condition=" '$(Configuration)' == 'Debug' And Exists('$(WixToolsetRootFolder)\Extensibility\src\WixToolset.Extensibility\WixToolset.Extensibility.csproj') " />
+    <PackageReference Include="WixToolset.Extensibility" Version="4.0.*" Condition=" '$(Configuration)' == 'Release' Or !Exists('$(WixToolsetRootFolder)\Extensibility\src\WixToolset.Extensibility\WixToolset.Extensibility.csproj') " />
+  </ItemGroup>
+
+</Project>
diff --git a/src/test/TestData/Example.Extension/ExampleCompilerExtension.cs b/src/test/TestData/Example.Extension/ExampleCompilerExtension.cs
new file mode 100644
index 00000000..5b20e48f
--- /dev/null
+++ b/src/test/TestData/Example.Extension/ExampleCompilerExtension.cs
@@ -0,0 +1,84 @@
+// 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 Example.Extension
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Xml.Linq;
+    using WixToolset.Data;
+    using WixToolset.Extensibility;
+
+    internal class ExampleCompilerExtension : BaseCompilerExtension
+    {
+        public ExampleCompilerExtension()
+        {
+            this.Namespace = "http://www.example.com/scheams/v1/wxs";
+        }
+
+        public override void ParseElement(Intermediate intermediate, IntermediateSection section, XElement parentElement, XElement element, IDictionary<string, string> context)
+        {
+            var processed = false;
+
+            switch (parentElement.Name.LocalName)
+            {
+                case "Component":
+                    switch (element.Name.LocalName)
+                    {
+                        case "Example":
+                            this.ParseExampleElement(intermediate, section, element);
+                            processed = true;
+                            break;
+                    }
+                    break;
+            }
+
+            if (!processed)
+            {
+                base.ParseElement(intermediate, section, parentElement, element, context);
+            }
+        }
+
+        private void ParseExampleElement(Intermediate intermediate, IntermediateSection section, XElement element)
+        {
+            var sourceLineNumbers = this.ParseHelper.GetSourceLineNumbers(element);
+            Identifier id = null;
+            string value = null;
+
+            foreach (var attrib in element.Attributes())
+            {
+                if (String.IsNullOrEmpty(attrib.Name.NamespaceName) || this.Namespace == attrib.Name.Namespace)
+                {
+                    switch (attrib.Name.LocalName)
+                    {
+                        case "Id":
+                            id = this.ParseHelper.GetAttributeIdentifier(sourceLineNumbers, attrib);
+                            break;
+
+                        case "Value":
+                            value = this.ParseHelper.GetAttributeValue(sourceLineNumbers, attrib);
+                            break;
+
+                        default:
+                            this.ParseHelper.UnexpectedAttribute(element, attrib);
+                            break;
+                    }
+                }
+                else
+                {
+                    this.ParseAttribute(intermediate, section, element, attrib, null);
+                }
+            }
+
+            if (null == id)
+            {
+                //this.Messaging(WixErrors.ExpectedAttribute(sourceLineNumbers, element.Name.LocalName, "Id"));
+            }
+
+            if (!this.Messaging.EncounteredError)
+            {
+                var tuple = this.ParseHelper.CreateRow(section, sourceLineNumbers, "Example", id);
+                tuple.Set(1, value);
+            }
+        }
+    }
+}
diff --git a/src/test/TestData/Example.Extension/ExampleExtensionData.cs b/src/test/TestData/Example.Extension/ExampleExtensionData.cs
new file mode 100644
index 00000000..6b179ea6
--- /dev/null
+++ b/src/test/TestData/Example.Extension/ExampleExtensionData.cs
@@ -0,0 +1,33 @@
+// 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 Example.Extension
+{
+    using WixToolset.Data;
+    using WixToolset.Extensibility;
+
+    internal class ExampleExtensionData : IExtensionData
+    {
+        public string DefaultCulture => null;
+
+        public Intermediate GetLibrary(ITupleDefinitionCreator tupleDefinitions)
+        {
+            return Intermediate.Load(typeof(ExampleExtensionData).Assembly, "Example.Extension.Data.Example.wir", tupleDefinitions);
+        }
+
+        public bool TryGetTupleDefinitionByName(string name, out IntermediateTupleDefinition tupleDefinition)
+        {
+            switch (name)
+            {
+                case "Example":
+                    tupleDefinition = TupleDefinitions.Example;
+                    break;
+
+                default:
+                    tupleDefinition = null;
+                    break;
+            }
+
+            return tupleDefinition != null;
+        }
+    }
+}
\ No newline at end of file
diff --git a/src/test/TestData/Example.Extension/ExampleExtensionFactory.cs b/src/test/TestData/Example.Extension/ExampleExtensionFactory.cs
new file mode 100644
index 00000000..b91d06e9
--- /dev/null
+++ b/src/test/TestData/Example.Extension/ExampleExtensionFactory.cs
@@ -0,0 +1,39 @@
+// 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 Example.Extension
+{
+    using System;
+    using WixToolset.Extensibility;
+
+    public class ExampleExtensionFactory : IExtensionFactory
+    {
+        private ExamplePreprocessorExtensionAndCommandLine preprocessorExtension;
+
+        public bool TryCreateExtension(Type extensionType, out object extension)
+        {
+            if (extensionType == typeof(IExtensionCommandLine) || extensionType == typeof(IPreprocessorExtension))
+            {
+                if (preprocessorExtension == null)
+                {
+                    preprocessorExtension = new ExamplePreprocessorExtensionAndCommandLine();
+                }
+
+                extension = preprocessorExtension;
+            }
+            else if (extensionType == typeof(ICompilerExtension))
+            {
+                extension = new ExampleCompilerExtension();
+            }
+            else if (extensionType == typeof(IExtensionData))
+            {
+                extension = new ExampleExtensionData();
+            }
+            else
+            {
+                extension = null;
+            }
+            
+            return extension != null;
+        }
+    }
+}
diff --git a/src/test/TestData/Example.Extension/ExamplePreprocessorExtensionAndCommandLine.cs b/src/test/TestData/Example.Extension/ExamplePreprocessorExtensionAndCommandLine.cs
new file mode 100644
index 00000000..53394ea3
--- /dev/null
+++ b/src/test/TestData/Example.Extension/ExamplePreprocessorExtensionAndCommandLine.cs
@@ -0,0 +1,46 @@
+// 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 Example.Extension
+{
+    using System;
+    using System.Collections.Generic;
+    using WixToolset.Extensibility;
+    using WixToolset.Extensibility.Services;
+
+    internal class ExamplePreprocessorExtensionAndCommandLine : BasePreprocessorExtension, IExtensionCommandLine
+    {
+        private string exampleValueFromCommandLine;
+
+        public IEnumerable<ExtensionCommandLineSwitch> CommandLineSwitches => throw new NotImplementedException();
+
+        public ExamplePreprocessorExtensionAndCommandLine()
+        {
+            this.Prefixes = new[] { "ex" };
+        }
+
+        public void PreParse(ICommandLineContext context)
+        {
+        }
+
+        public bool TryParseArgument(IParseCommandLine parseCommandLine, string arg)
+        {
+            if (parseCommandLine.IsSwitch(arg) && arg.Substring(1).Equals("example", StringComparison.OrdinalIgnoreCase))
+            {
+                parseCommandLine.GetNextArgumentOrError(ref this.exampleValueFromCommandLine);
+                return true;
+            }
+
+            return false;
+        }
+
+        public override string GetVariableValue(string prefix, string name)
+        {
+            if (prefix == "ex" && "test".Equals(name, StringComparison.OrdinalIgnoreCase))
+            {
+                return String.IsNullOrWhiteSpace(this.exampleValueFromCommandLine) ? "(null)" : this.exampleValueFromCommandLine;
+            }
+
+            return null;
+        }
+    }
+}
\ No newline at end of file
diff --git a/src/test/TestData/Example.Extension/ExampleTuple.cs b/src/test/TestData/Example.Extension/ExampleTuple.cs
new file mode 100644
index 00000000..f280a5c8
--- /dev/null
+++ b/src/test/TestData/Example.Extension/ExampleTuple.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 Example.Extension
+{
+    using WixToolset.Data;
+
+    public enum ExampleTupleFields
+    {
+        Example,
+        Value,
+    }
+
+    public class ExampleTuple : IntermediateTuple
+    {
+        public ExampleTuple() : base(TupleDefinitions.Example, null, null)
+        {
+        }
+
+        public ExampleTuple(SourceLineNumber sourceLineNumber, Identifier id = null) : base(TupleDefinitions.Example, sourceLineNumber, id)
+        {
+        }
+
+        public IntermediateField this[ExampleTupleFields index] => this.Fields[(int)index];
+
+        public string Value
+        {
+            get => this.Fields[(int)ExampleTupleFields.Value]?.AsString();
+            set => this.Set((int)ExampleTupleFields.Value, value);
+        }
+    }
+}
diff --git a/src/test/TestData/Example.Extension/TupleDefinitions.cs b/src/test/TestData/Example.Extension/TupleDefinitions.cs
new file mode 100644
index 00000000..2c320fbc
--- /dev/null
+++ b/src/test/TestData/Example.Extension/TupleDefinitions.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 Example.Extension
+{
+    using WixToolset.Data;
+
+    public static class TupleDefinitions
+    {
+        public static readonly IntermediateTupleDefinition Example = new IntermediateTupleDefinition(
+            "Example",
+            new[]
+            {
+                new IntermediateFieldDefinition(nameof(ExampleTupleFields.Example), IntermediateFieldType.String),
+                new IntermediateFieldDefinition(nameof(ExampleTupleFields.Value), IntermediateFieldType.String),
+            },
+            typeof(ExampleTuple));
+    }
+}