From 13eedbfcf97e402ade06f2be29f98723ef7ff286 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Thu, 18 Oct 2018 13:42:54 -0700 Subject: Extract interfaces for Preprocess/Compile/Link/Bind/etc --- src/WixToolset.Core.Burn/BundleBackend.cs | 5 + src/WixToolset.Core.Burn/BurnBackendFactory.cs | 2 +- src/WixToolset.Core.WindowsInstaller/MsiBackend.cs | 5 + src/WixToolset.Core.WindowsInstaller/MsmBackend.cs | 5 + src/WixToolset.Core.WindowsInstaller/MspBackend.cs | 5 + src/WixToolset.Core.WindowsInstaller/MstBackend.cs | 5 + src/WixToolset.Core.WindowsInstaller/Unbinder.cs | 2 +- .../WindowsInstallerBackendFactory.cs | 2 +- src/WixToolset.Core/Binder.cs | 57 +- src/WixToolset.Core/CommandLine/BuildCommand.cs | 194 ++++--- src/WixToolset.Core/CommandLine/CompileCommand.cs | 31 +- src/WixToolset.Core/Compiler.cs | 25 +- src/WixToolset.Core/DecompileContext.cs | 28 + src/WixToolset.Core/Decompiler.cs | 75 +++ src/WixToolset.Core/IBinder.cs | 11 + src/WixToolset.Core/ICompiler.cs | 12 + src/WixToolset.Core/IDecompiler.cs | 11 + src/WixToolset.Core/ILayoutCreator.cs | 11 + src/WixToolset.Core/ILibrarian.cs | 12 + src/WixToolset.Core/ILinker.cs | 12 + src/WixToolset.Core/IPreprocessor.cs | 15 + src/WixToolset.Core/IResolver.cs | 11 + src/WixToolset.Core/Layout.cs | 253 --------- src/WixToolset.Core/LayoutContext.cs | 2 +- src/WixToolset.Core/LayoutCreator.cs | 227 ++++++++ src/WixToolset.Core/Librarian.cs | 52 +- src/WixToolset.Core/Linker.cs | 441 ++++++++------- src/WixToolset.Core/PreprocessContext.cs | 4 +- src/WixToolset.Core/Preprocessor.cs | 597 ++++++++++----------- src/WixToolset.Core/Resolver.cs | 25 +- src/WixToolset.Core/WixToolsetServiceProvider.cs | 11 + 31 files changed, 1143 insertions(+), 1005 deletions(-) create mode 100644 src/WixToolset.Core/DecompileContext.cs create mode 100644 src/WixToolset.Core/Decompiler.cs create mode 100644 src/WixToolset.Core/IBinder.cs create mode 100644 src/WixToolset.Core/ICompiler.cs create mode 100644 src/WixToolset.Core/IDecompiler.cs create mode 100644 src/WixToolset.Core/ILayoutCreator.cs create mode 100644 src/WixToolset.Core/ILibrarian.cs create mode 100644 src/WixToolset.Core/ILinker.cs create mode 100644 src/WixToolset.Core/IPreprocessor.cs create mode 100644 src/WixToolset.Core/IResolver.cs delete mode 100644 src/WixToolset.Core/Layout.cs create mode 100644 src/WixToolset.Core/LayoutCreator.cs diff --git a/src/WixToolset.Core.Burn/BundleBackend.cs b/src/WixToolset.Core.Burn/BundleBackend.cs index 96a35b14..3baa526e 100644 --- a/src/WixToolset.Core.Burn/BundleBackend.cs +++ b/src/WixToolset.Core.Burn/BundleBackend.cs @@ -27,6 +27,11 @@ namespace WixToolset.Core.Burn return new BindResult { FileTransfers = command.FileTransfers, TrackedFiles = command.TrackedFiles }; } + public BindResult Decompile(IDecompileContext context) + { + throw new NotImplementedException(); + } + public bool Inscribe(IInscribeContext context) { if (String.IsNullOrEmpty(context.SignedEngineFile)) diff --git a/src/WixToolset.Core.Burn/BurnBackendFactory.cs b/src/WixToolset.Core.Burn/BurnBackendFactory.cs index 5f98ada9..4b2e833f 100644 --- a/src/WixToolset.Core.Burn/BurnBackendFactory.cs +++ b/src/WixToolset.Core.Burn/BurnBackendFactory.cs @@ -9,7 +9,7 @@ namespace WixToolset.Core.Burn internal class BurnBackendFactory : IBackendFactory { - public bool TryCreateBackend(string outputType, string outputFile, IBindContext context, out IBackend backend) + public bool TryCreateBackend(string outputType, string outputFile, out IBackend backend) { if (String.IsNullOrEmpty(outputType)) { diff --git a/src/WixToolset.Core.WindowsInstaller/MsiBackend.cs b/src/WixToolset.Core.WindowsInstaller/MsiBackend.cs index c0c518f8..8b63ae9a 100644 --- a/src/WixToolset.Core.WindowsInstaller/MsiBackend.cs +++ b/src/WixToolset.Core.WindowsInstaller/MsiBackend.cs @@ -38,6 +38,11 @@ namespace WixToolset.Core.WindowsInstaller return result; } + public BindResult Decompile(IDecompileContext context) + { + throw new NotImplementedException(); + } + public bool Inscribe(IInscribeContext context) { var command = new InscribeMsiPackageCommand(context); diff --git a/src/WixToolset.Core.WindowsInstaller/MsmBackend.cs b/src/WixToolset.Core.WindowsInstaller/MsmBackend.cs index 6c97f08d..c12e6c79 100644 --- a/src/WixToolset.Core.WindowsInstaller/MsmBackend.cs +++ b/src/WixToolset.Core.WindowsInstaller/MsmBackend.cs @@ -43,6 +43,11 @@ namespace WixToolset.Core.WindowsInstaller return result; } + public BindResult Decompile(IDecompileContext context) + { + throw new NotImplementedException(); + } + public bool Inscribe(IInscribeContext context) { return false; diff --git a/src/WixToolset.Core.WindowsInstaller/MspBackend.cs b/src/WixToolset.Core.WindowsInstaller/MspBackend.cs index a47802bb..c6a05b20 100644 --- a/src/WixToolset.Core.WindowsInstaller/MspBackend.cs +++ b/src/WixToolset.Core.WindowsInstaller/MspBackend.cs @@ -21,6 +21,11 @@ namespace WixToolset.Core.WindowsInstaller throw new NotImplementedException(); } + public BindResult Decompile(IDecompileContext context) + { + throw new NotImplementedException(); + } + public bool Inscribe(IInscribeContext context) { throw new NotImplementedException(); diff --git a/src/WixToolset.Core.WindowsInstaller/MstBackend.cs b/src/WixToolset.Core.WindowsInstaller/MstBackend.cs index fa696d55..3e105963 100644 --- a/src/WixToolset.Core.WindowsInstaller/MstBackend.cs +++ b/src/WixToolset.Core.WindowsInstaller/MstBackend.cs @@ -25,6 +25,11 @@ namespace WixToolset.Core.WindowsInstaller throw new NotImplementedException(); } + public BindResult Decompile(IDecompileContext context) + { + throw new NotImplementedException(); + } + public bool Inscribe(IInscribeContext context) { throw new NotImplementedException(); diff --git a/src/WixToolset.Core.WindowsInstaller/Unbinder.cs b/src/WixToolset.Core.WindowsInstaller/Unbinder.cs index db121fc0..e8c109d2 100644 --- a/src/WixToolset.Core.WindowsInstaller/Unbinder.cs +++ b/src/WixToolset.Core.WindowsInstaller/Unbinder.cs @@ -74,7 +74,7 @@ namespace WixToolset.Core foreach (var factory in this.BackendFactories) { - if (factory.TryCreateBackend(outputType.ToString(), file, null, out var backend)) + if (factory.TryCreateBackend(outputType.ToString(), file, out var backend)) { return backend.Unbind(context); } diff --git a/src/WixToolset.Core.WindowsInstaller/WindowsInstallerBackendFactory.cs b/src/WixToolset.Core.WindowsInstaller/WindowsInstallerBackendFactory.cs index 8ffa1a03..173404d7 100644 --- a/src/WixToolset.Core.WindowsInstaller/WindowsInstallerBackendFactory.cs +++ b/src/WixToolset.Core.WindowsInstaller/WindowsInstallerBackendFactory.cs @@ -9,7 +9,7 @@ namespace WixToolset.Core.WindowsInstaller internal class WindowsInstallerBackendFactory : IBackendFactory { - public bool TryCreateBackend(string outputType, string outputFile, IBindContext context, out IBackend backend) + public bool TryCreateBackend(string outputType, string outputFile, out IBackend backend) { if (String.IsNullOrEmpty(outputType)) { diff --git a/src/WixToolset.Core/Binder.cs b/src/WixToolset.Core/Binder.cs index bbc4173b..87b5d2b3 100644 --- a/src/WixToolset.Core/Binder.cs +++ b/src/WixToolset.Core/Binder.cs @@ -3,7 +3,6 @@ namespace WixToolset.Core { using System; - using System.Collections.Generic; using System.Diagnostics; using System.Linq; using System.Reflection; @@ -16,61 +15,17 @@ namespace WixToolset.Core /// /// Binder of the WiX toolset. /// - internal class Binder + internal class Binder : IBinder { internal Binder(IServiceProvider serviceProvider) { this.ServiceProvider = serviceProvider; } - public int CabbingThreadCount { get; set; } - - public string CabCachePath { get; set; } - - public int Codepage { get; set; } - - public CompressionLevel? DefaultCompressionLevel { get; set; } - - public IEnumerable DelayedFields { get; set; } - - public IEnumerable ExpectedEmbeddedFiles { get; set; } - - public IEnumerable Ices { get; set; } - - public string IntermediateFolder { get; set; } - - public Intermediate IntermediateRepresentation { get; set; } - - public string OutputPath { get; set; } - - public string OutputPdbPath { get; set; } - - public IEnumerable SuppressIces { get; set; } - - public bool SuppressValidation { get; set; } - - public bool DeltaBinaryPatch { get; set; } - public IServiceProvider ServiceProvider { get; } - public BindResult Execute() + public BindResult Bind(IBindContext context) { - var context = this.ServiceProvider.GetService(); - context.CabbingThreadCount = this.CabbingThreadCount; - context.CabCachePath = this.CabCachePath; - context.Codepage = this.Codepage; - context.DefaultCompressionLevel = this.DefaultCompressionLevel; - context.DelayedFields = this.DelayedFields; - context.ExpectedEmbeddedFiles = this.ExpectedEmbeddedFiles; - context.Extensions = this.ServiceProvider.GetService().Create(); - context.Ices = this.Ices; - context.IntermediateFolder = this.IntermediateFolder; - context.IntermediateRepresentation = this.IntermediateRepresentation; - context.OutputPath = this.OutputPath; - context.OutputPdbPath = this.OutputPdbPath; - context.SuppressIces = this.SuppressIces; - context.SuppressValidation = this.SuppressValidation; - // Prebind. // foreach (var extension in context.Extensions) @@ -80,7 +35,7 @@ namespace WixToolset.Core // Bind. // - this.WriteBuildInfoTable(context.IntermediateRepresentation, context.OutputPath, context.OutputPdbPath); + this.WriteBuildInfoTuple(context.IntermediateRepresentation, context.OutputPath, context.OutputPdbPath); var bindResult = this.BackendBind(context); @@ -107,7 +62,7 @@ namespace WixToolset.Core foreach (var factory in backendFactories) { - if (factory.TryCreateBackend(entrySection.Type.ToString(), context.OutputPath, null, out var backend)) + if (factory.TryCreateBackend(entrySection.Type.ToString(), context.OutputPath, out var backend)) { var result = backend.Bind(context); return result; @@ -118,8 +73,8 @@ namespace WixToolset.Core return null; } - - private void WriteBuildInfoTable(Intermediate output, string outputFile, string outputPdbPath) + + private void WriteBuildInfoTuple(Intermediate output, string outputFile, string outputPdbPath) { var entrySection = output.Sections.First(s => s.Type != SectionType.Fragment); diff --git a/src/WixToolset.Core/CommandLine/BuildCommand.cs b/src/WixToolset.Core/CommandLine/BuildCommand.cs index 76502bb0..6052d979 100644 --- a/src/WixToolset.Core/CommandLine/BuildCommand.cs +++ b/src/WixToolset.Core/CommandLine/BuildCommand.cs @@ -8,6 +8,7 @@ namespace WixToolset.Core.CommandLine using System.Linq; using System.Xml.Linq; using WixToolset.Data; + using WixToolset.Extensibility; using WixToolset.Extensibility.Data; using WixToolset.Extensibility.Services; @@ -172,16 +173,24 @@ namespace WixToolset.Core.CommandLine foreach (var sourceFile in sourceFiles) { - var preprocessor = new Preprocessor(this.ServiceProvider); - preprocessor.IncludeSearchPaths = this.IncludeSearchPaths; - preprocessor.Platform = this.Platform; - preprocessor.SourcePath = sourceFile.SourcePath; - preprocessor.Variables = this.PreprocessorVariables; + var document = this.Preprocess(sourceFile.SourcePath); - XDocument document = null; + if (this.Messaging.EncounteredError) + { + continue; + } + + var context = this.ServiceProvider.GetService(); + context.Extensions = this.ExtensionManager.Create(); + context.OutputPath = sourceFile.OutputPath; + context.Platform = this.Platform; + context.Source = document; + + Intermediate intermediate = null; try { - document = preprocessor.Execute(); + var compiler = this.ServiceProvider.GetService(); + intermediate = compiler.Compile(context); } catch (WixException e) { @@ -193,17 +202,6 @@ namespace WixToolset.Core.CommandLine continue; } - var compiler = new Compiler(this.ServiceProvider); - compiler.OutputPath = sourceFile.OutputPath; - compiler.Platform = this.Platform; - compiler.SourceDocument = document; - var intermediate = compiler.Execute(); - - if (this.Messaging.EncounteredError) - { - continue; - } - intermediates.Add(intermediate); } @@ -212,14 +210,27 @@ namespace WixToolset.Core.CommandLine private Intermediate LibraryPhase(IEnumerable intermediates, IEnumerable localizations) { - var librarian = new Librarian(this.ServiceProvider); - librarian.BindFiles = this.BindFiles; - librarian.BindPaths = this.BindPaths; - librarian.Intermediates = intermediates; - librarian.Localizations = localizations; - return librarian.Execute(); - } + var context = this.ServiceProvider.GetService(); + context.BindFiles = this.BindFiles; + context.BindPaths = this.BindPaths; + context.Extensions = this.ExtensionManager.Create(); + context.Localizations = localizations; + context.Intermediates = intermediates; + + Intermediate library = null; + try + { + var librarian = this.ServiceProvider.GetService(); + library = librarian.Combine(context); + } + catch (WixException e) + { + this.Messaging.Write(e.Error); + } + return library; + } + private Intermediate LinkPhase(IEnumerable intermediates, ITupleDefinitionCreator creator) { var libraries = this.LoadLibraries(creator); @@ -229,26 +240,39 @@ namespace WixToolset.Core.CommandLine return null; } - var linker = new Linker(this.ServiceProvider); - linker.OutputType = this.OutputType; - linker.Intermediates = intermediates; - linker.Libraries = libraries; - linker.TupleDefinitionCreator = creator; - return linker.Execute(); + var context = this.ServiceProvider.GetService(); + context.Extensions = this.ExtensionManager.Create(); + context.ExtensionData = this.ExtensionManager.Create(); + context.ExpectedOutputType = this.OutputType; + context.Intermediates = intermediates.Concat(libraries).ToList(); + context.TupleDefinitionCreator = creator; + + var linker = this.ServiceProvider.GetService(); + return linker.Link(context); } private void BindPhase(Intermediate output, IEnumerable localizations) { + var intermediateFolder = this.IntermediateFolder; + if (String.IsNullOrEmpty(intermediateFolder)) + { + intermediateFolder = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName()); + } + ResolveResult resolveResult; { - var resolver = new Resolver(this.ServiceProvider); - resolver.BindPaths = this.BindPaths; - resolver.FilterCultures = this.FilterCultures; - resolver.IntermediateFolder = this.IntermediateFolder; - resolver.IntermediateRepresentation = output; - resolver.Localizations = localizations; - - resolveResult = resolver.Execute(); + var context = this.ServiceProvider.GetService(); + context.BindPaths = this.BindPaths; + context.Extensions = this.ExtensionManager.Create(); + context.ExtensionData = this.ExtensionManager.Create(); + context.FilterCultures = this.FilterCultures; + context.IntermediateFolder = intermediateFolder; + context.IntermediateRepresentation = output; + context.Localizations = localizations; + context.VariableResolver = new WixVariableResolver(this.Messaging); + + var resolver = this.ServiceProvider.GetService(); + resolveResult = resolver.Resolve(context); } if (this.Messaging.EncounteredError) @@ -258,28 +282,24 @@ namespace WixToolset.Core.CommandLine BindResult bindResult; { - var intermediateFolder = this.IntermediateFolder; - if (String.IsNullOrEmpty(intermediateFolder)) - { - intermediateFolder = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName()); - } - - var binder = new Binder(this.ServiceProvider); - //binder.CabbingThreadCount = this.CabbingThreadCount; - binder.CabCachePath = this.CabCachePath; - binder.Codepage = resolveResult.Codepage; - //binder.DefaultCompressionLevel = this.DefaultCompressionLevel; - binder.DelayedFields = resolveResult.DelayedFields; - binder.ExpectedEmbeddedFiles = resolveResult.ExpectedEmbeddedFiles; - binder.Ices = Array.Empty(); // TODO: set this correctly - binder.IntermediateFolder = intermediateFolder; - binder.IntermediateRepresentation = resolveResult.IntermediateRepresentation; - binder.OutputPath = this.OutputPath; - binder.OutputPdbPath = Path.ChangeExtension(this.OutputPath, ".wixpdb"); - binder.SuppressIces = Array.Empty(); // TODO: set this correctly - binder.SuppressValidation = true; // TODO: set this correctly - - bindResult = binder.Execute(); + var context = this.ServiceProvider.GetService(); + //context.CabbingThreadCount = this.CabbingThreadCount; + context.CabCachePath = this.CabCachePath; + context.Codepage = resolveResult.Codepage; + //context.DefaultCompressionLevel = this.DefaultCompressionLevel; + context.DelayedFields = resolveResult.DelayedFields; + context.ExpectedEmbeddedFiles = resolveResult.ExpectedEmbeddedFiles; + context.Extensions = this.ExtensionManager.Create(); + context.Ices = Array.Empty(); // TODO: set this correctly + context.IntermediateFolder = intermediateFolder; + context.IntermediateRepresentation = resolveResult.IntermediateRepresentation; + context.OutputPath = this.OutputPath; + context.OutputPdbPath = Path.ChangeExtension(this.OutputPath, ".wixpdb"); + context.SuppressIces = Array.Empty(); // TODO: set this correctly + context.SuppressValidation = true; // TODO: set this correctly + + var binder = this.ServiceProvider.GetService(); + bindResult = binder.Bind(context); } if (this.Messaging.EncounteredError) @@ -288,16 +308,18 @@ namespace WixToolset.Core.CommandLine } { - var layout = new Layout(this.ServiceProvider); - layout.TrackedFiles = bindResult.TrackedFiles; - layout.FileTransfers = bindResult.FileTransfers; - layout.IntermediateFolder = this.IntermediateFolder; - layout.ContentsFile = this.ContentsFile; - layout.OutputsFile = this.OutputsFile; - layout.BuiltOutputsFile = this.BuiltOutputsFile; - layout.SuppressAclReset = false; // TODO: correctly set SuppressAclReset - - layout.Execute(); + var context = this.ServiceProvider.GetService(); + context.Extensions = this.ExtensionManager.Create(); + context.TrackedFiles = bindResult.TrackedFiles; + context.FileTransfers = bindResult.FileTransfers; + context.IntermediateFolder = intermediateFolder; + context.ContentsFile = this.ContentsFile; + context.OutputsFile = this.OutputsFile; + context.BuiltOutputsFile = this.BuiltOutputsFile; + context.SuppressAclReset = false; // TODO: correctly set SuppressAclReset + + var layout = this.ServiceProvider.GetService(); + layout.Layout(context); } } @@ -335,12 +357,7 @@ namespace WixToolset.Core.CommandLine foreach (var loc in this.LocFiles) { - var preprocessor = new Preprocessor(this.ServiceProvider); - preprocessor.IncludeSearchPaths = this.IncludeSearchPaths; - preprocessor.Platform = Platform.X86; // TODO: set this correctly - preprocessor.SourcePath = loc; - preprocessor.Variables = this.PreprocessorVariables; - var document = preprocessor.Execute(); + var document = this.Preprocess(loc); if (this.Messaging.EncounteredError) { @@ -351,5 +368,28 @@ namespace WixToolset.Core.CommandLine yield return localization; } } + + private XDocument Preprocess(string sourcePath) + { + var context = this.ServiceProvider.GetService(); + context.Extensions = this.ExtensionManager.Create(); + context.Platform = this.Platform; + context.IncludeSearchPaths = this.IncludeSearchPaths; + context.SourcePath = sourcePath; + context.Variables = this.PreprocessorVariables; + + XDocument document = null; + try + { + var preprocessor = this.ServiceProvider.GetService(); + document = preprocessor.Preprocess(context); + } + catch (WixException e) + { + this.Messaging.Write(e.Error); + } + + return document; + } } } diff --git a/src/WixToolset.Core/CommandLine/CompileCommand.cs b/src/WixToolset.Core/CommandLine/CompileCommand.cs index 621571b1..4007c263 100644 --- a/src/WixToolset.Core/CommandLine/CompileCommand.cs +++ b/src/WixToolset.Core/CommandLine/CompileCommand.cs @@ -6,6 +6,7 @@ namespace WixToolset.Core.CommandLine using System.Collections.Generic; using System.Xml.Linq; using WixToolset.Data; + using WixToolset.Extensibility; using WixToolset.Extensibility.Data; using WixToolset.Extensibility.Services; @@ -15,6 +16,7 @@ namespace WixToolset.Core.CommandLine { this.ServiceProvider = serviceProvider; this.Messaging = serviceProvider.GetService(); + this.ExtensionManager = serviceProvider.GetService(); this.SourceFiles = sources; this.PreprocessorVariables = preprocessorVariables; this.Platform = platform; @@ -24,6 +26,8 @@ namespace WixToolset.Core.CommandLine public IMessaging Messaging { get; } + public IExtensionManager ExtensionManager { get; } + private IEnumerable SourceFiles { get; } private IDictionary PreprocessorVariables { get; } @@ -36,16 +40,18 @@ namespace WixToolset.Core.CommandLine { foreach (var sourceFile in this.SourceFiles) { - var preprocessor = new Preprocessor(this.ServiceProvider); - preprocessor.IncludeSearchPaths = this.IncludeSearchPaths; - preprocessor.Platform = Platform.X86; // TODO: set this correctly - preprocessor.SourcePath = sourceFile.SourcePath; - preprocessor.Variables = new Dictionary(this.PreprocessorVariables); + var context = this.ServiceProvider.GetService(); + context.Extensions = this.ExtensionManager.Create(); + context.Platform = this.Platform; + context.IncludeSearchPaths = this.IncludeSearchPaths; + context.SourcePath = sourceFile.SourcePath; + context.Variables = this.PreprocessorVariables; XDocument document = null; try { - document = preprocessor.Execute(); + var preprocessor = this.ServiceProvider.GetService(); + document = preprocessor.Preprocess(context); } catch (WixException e) { @@ -57,11 +63,14 @@ namespace WixToolset.Core.CommandLine continue; } - var compiler = new Compiler(this.ServiceProvider); - compiler.OutputPath = sourceFile.OutputPath; - compiler.Platform = this.Platform; - compiler.SourceDocument = document; - var intermediate = compiler.Execute(); + var compileContext = this.ServiceProvider.GetService(); + compileContext.Extensions = this.ExtensionManager.Create(); + compileContext.OutputPath = sourceFile.OutputPath; + compileContext.Platform = this.Platform; + compileContext.Source = document; + + var compiler = this.ServiceProvider.GetService(); + var intermediate = compiler.Compile(compileContext); intermediate.Save(sourceFile.OutputPath); } diff --git a/src/WixToolset.Core/Compiler.cs b/src/WixToolset.Core/Compiler.cs index 7d09be6d..ffe907e8 100644 --- a/src/WixToolset.Core/Compiler.cs +++ b/src/WixToolset.Core/Compiler.cs @@ -22,7 +22,7 @@ namespace WixToolset.Core /// /// Compiler of the WiX toolset. /// - internal class Compiler + internal class Compiler : ICompiler { public const string UpgradeDetectedProperty = "WIX_UPGRADE_DETECTED"; public const string UpgradePreventedCondition = "NOT WIX_UPGRADE_DETECTED"; @@ -84,14 +84,6 @@ namespace WixToolset.Core private CompilerCore Core { get; set; } - public string CompliationId { get; set; } - - public string OutputPath { get; set; } - - public Platform Platform { get; set; } - - public XDocument SourceDocument { get; set; } - /// /// Gets or sets the platform which the compiler will use when defaulting 64-bit attributes and elements. /// @@ -109,22 +101,17 @@ namespace WixToolset.Core /// /// Intermediate object representing compiled source document. /// This method is not thread-safe. - public Intermediate Execute() + public Intermediate Compile(ICompileContext context) { - this.Context = this.ServiceProvider.GetService(); - this.Context.Extensions = this.ServiceProvider.GetService().Create(); - this.Context.CompilationId = this.CompliationId; - this.Context.OutputPath = this.OutputPath; - this.Context.Platform = this.Platform; - this.Context.Source = this.SourceDocument; - var target = new Intermediate(); - if (String.IsNullOrEmpty(this.Context.CompilationId)) + if (String.IsNullOrEmpty(context.CompilationId)) { - this.Context.CompilationId = target.Id; + context.CompilationId = target.Id; } + this.Context = context; + var extensionsByNamespace = new Dictionary(); foreach (var extension in this.Context.Extensions) diff --git a/src/WixToolset.Core/DecompileContext.cs b/src/WixToolset.Core/DecompileContext.cs new file mode 100644 index 00000000..a9f0640a --- /dev/null +++ b/src/WixToolset.Core/DecompileContext.cs @@ -0,0 +1,28 @@ +// 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.Core +{ + using System; + using System.Collections.Generic; + using WixToolset.Data; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Data; + + internal class DecompileContext : IDecompileContext + { + internal DecompileContext(IServiceProvider serviceProvider) + { + this.ServiceProvider = serviceProvider; + } + + public IServiceProvider ServiceProvider { get; } + + public OutputType DecompileType { get; set; } + + public IEnumerable Extensions { get; set; } + + public string IntermediateFolder { get; set; } + + public string OutputPath { get; set; } + } +} diff --git a/src/WixToolset.Core/Decompiler.cs b/src/WixToolset.Core/Decompiler.cs new file mode 100644 index 00000000..5f14dfca --- /dev/null +++ b/src/WixToolset.Core/Decompiler.cs @@ -0,0 +1,75 @@ +// 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.Core +{ + using System; + using WixToolset.Data; + using WixToolset.Extensibility; + using WixToolset.Extensibility.Data; + using WixToolset.Extensibility.Services; + + /// + /// Decompiler of the WiX toolset. + /// + internal class Decompiler : IDecompiler + { + internal Decompiler(IServiceProvider serviceProvider) + { + this.ServiceProvider = serviceProvider; + } + + public OutputType DecompileType { get; set; } + + public string IntermediateFolder { get; set; } + + public string OutputPath { get; set; } + + public IServiceProvider ServiceProvider { get; } + + public BindResult Decompile(IDecompileContext context) + { + // Pre-decompile. + // + foreach (var extension in context.Extensions) + { + extension.PreDecompile(context); + } + + // Decompile. + // + var bindResult = this.BackendDecompile(context); + + if (bindResult != null) + { + // Post-decompile. + // + foreach (var extension in context.Extensions) + { + extension.PostDecompile(bindResult); + } + } + + return bindResult; + } + + private BindResult BackendDecompile(IDecompileContext context) + { + var extensionManager = context.ServiceProvider.GetService(); + + var backendFactories = extensionManager.Create(); + + foreach (var factory in backendFactories) + { + if (factory.TryCreateBackend(context.DecompileType.ToString(), context.OutputPath, out var backend)) + { + var result = backend.Decompile(context); + return result; + } + } + + // TODO: messaging that a backend could not be found to decompile the decompile type? + + return null; + } + } +} diff --git a/src/WixToolset.Core/IBinder.cs b/src/WixToolset.Core/IBinder.cs new file mode 100644 index 00000000..884ee6b9 --- /dev/null +++ b/src/WixToolset.Core/IBinder.cs @@ -0,0 +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.Core +{ + using WixToolset.Extensibility.Data; + + public interface IBinder + { + BindResult Bind(IBindContext context); + } +} diff --git a/src/WixToolset.Core/ICompiler.cs b/src/WixToolset.Core/ICompiler.cs new file mode 100644 index 00000000..a2c4a6e8 --- /dev/null +++ b/src/WixToolset.Core/ICompiler.cs @@ -0,0 +1,12 @@ +// 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.Core +{ + using WixToolset.Data; + using WixToolset.Extensibility.Data; + + public interface ICompiler + { + Intermediate Compile(ICompileContext context); + } +} diff --git a/src/WixToolset.Core/IDecompiler.cs b/src/WixToolset.Core/IDecompiler.cs new file mode 100644 index 00000000..b9bb7ed8 --- /dev/null +++ b/src/WixToolset.Core/IDecompiler.cs @@ -0,0 +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.Core +{ + using WixToolset.Extensibility.Data; + + public interface IDecompiler + { + BindResult Decompile(IDecompileContext context); + } +} diff --git a/src/WixToolset.Core/ILayoutCreator.cs b/src/WixToolset.Core/ILayoutCreator.cs new file mode 100644 index 00000000..f58d0aad --- /dev/null +++ b/src/WixToolset.Core/ILayoutCreator.cs @@ -0,0 +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.Core +{ + using WixToolset.Extensibility.Data; + + public interface ILayoutCreator + { + void Layout(ILayoutContext context); + } +} diff --git a/src/WixToolset.Core/ILibrarian.cs b/src/WixToolset.Core/ILibrarian.cs new file mode 100644 index 00000000..3e951e65 --- /dev/null +++ b/src/WixToolset.Core/ILibrarian.cs @@ -0,0 +1,12 @@ +// 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.Core +{ + using WixToolset.Data; + using WixToolset.Extensibility.Data; + + public interface ILibrarian + { + Intermediate Combine(ILibraryContext context); + } +} diff --git a/src/WixToolset.Core/ILinker.cs b/src/WixToolset.Core/ILinker.cs new file mode 100644 index 00000000..0580bf46 --- /dev/null +++ b/src/WixToolset.Core/ILinker.cs @@ -0,0 +1,12 @@ +// 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.Core +{ + using WixToolset.Data; + using WixToolset.Extensibility.Data; + + public interface ILinker + { + Intermediate Link(ILinkContext context); + } +} diff --git a/src/WixToolset.Core/IPreprocessor.cs b/src/WixToolset.Core/IPreprocessor.cs new file mode 100644 index 00000000..946d8cc2 --- /dev/null +++ b/src/WixToolset.Core/IPreprocessor.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.Core +{ + using System.Xml; + using System.Xml.Linq; + using WixToolset.Extensibility.Data; + + internal interface IPreprocessor + { + XDocument Preprocess(IPreprocessContext context); + + XDocument Preprocess(IPreprocessContext context, XmlReader reader); + } +} diff --git a/src/WixToolset.Core/IResolver.cs b/src/WixToolset.Core/IResolver.cs new file mode 100644 index 00000000..a027f348 --- /dev/null +++ b/src/WixToolset.Core/IResolver.cs @@ -0,0 +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.Core +{ + using WixToolset.Extensibility.Data; + + public interface IResolver + { + ResolveResult Resolve(IResolveContext context); + } +} diff --git a/src/WixToolset.Core/Layout.cs b/src/WixToolset.Core/Layout.cs deleted file mode 100644 index b1b03aa7..00000000 --- a/src/WixToolset.Core/Layout.cs +++ /dev/null @@ -1,253 +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.Core -{ - using System; - using System.Collections.Generic; - using System.IO; - using System.Linq; - using WixToolset.Core.Bind; - using WixToolset.Data; - using WixToolset.Extensibility; - using WixToolset.Extensibility.Data; - using WixToolset.Extensibility.Services; - - /// - /// Layout for the WiX toolset. - /// - internal class Layout - { - internal Layout(IServiceProvider serviceProvider) - { - this.ServiceProvider = serviceProvider; - - this.Messaging = serviceProvider.GetService(); - } - - private IServiceProvider ServiceProvider { get; } - - private IMessaging Messaging { get; } - - public IEnumerable TrackedFiles { get; set; } - - public IEnumerable FileTransfers { get; set; } - - public string IntermediateFolder { get; set; } - - public string ContentsFile { get; set; } - - public string OutputsFile { get; set; } - - public string BuiltOutputsFile { get; set; } - - public bool SuppressAclReset { get; set; } - - public void Execute() - { - var extensionManager = this.ServiceProvider.GetService(); - - var context = this.ServiceProvider.GetService(); - context.Extensions = extensionManager.Create(); - context.TrackedFiles = this.TrackedFiles; - context.FileTransfers = this.FileTransfers; - context.ContentsFile = this.ContentsFile; - context.OutputsFile = this.OutputsFile; - context.BuiltOutputsFile = this.BuiltOutputsFile; - context.SuppressAclReset = this.SuppressAclReset; - - // Pre-layout. - // - foreach (var extension in context.Extensions) - { - extension.PreLayout(context); - } - - try - { - // Final step in binding that transfers (moves/copies) all files generated into the appropriate - // location in the source image. - if (context.FileTransfers?.Any() == true) - { - this.Messaging.Write(VerboseMessages.LayingOutMedia()); - - var command = new TransferFilesCommand(this.Messaging, context.Extensions, context.FileTransfers, context.SuppressAclReset); - command.Execute(); - } - - if (context.TrackedFiles != null) - { - this.CleanTempFiles(context.TrackedFiles); - } - } - finally - { - if (context.TrackedFiles != null) - { - if (!String.IsNullOrEmpty(context.ContentsFile)) - { - this.CreateContentsFile(context.ContentsFile, context.TrackedFiles); - } - - if (!String.IsNullOrEmpty(context.OutputsFile)) - { - this.CreateOutputsFile(context.OutputsFile, context.TrackedFiles); - } - - if (!String.IsNullOrEmpty(context.BuiltOutputsFile)) - { - this.CreateBuiltOutputsFile(context.BuiltOutputsFile, context.TrackedFiles); - } - } - } - - // Post-layout. - foreach (var extension in context.Extensions) - { - extension.PostLayout(); - } - } - - /// - /// Writes the paths to the content files to a text file. - /// - /// Path to write file. - /// Collection of paths to content files that will be written to file. - private void CreateContentsFile(string path, IEnumerable trackedFiles) - { - var uniqueInputFilePaths = new SortedSet(trackedFiles.Where(t => t.Type == TrackedFileType.Input).Select(t => t.Path), StringComparer.OrdinalIgnoreCase); - - if (!uniqueInputFilePaths.Any()) - { - return; - } - - var directory = Path.GetDirectoryName(path); - Directory.CreateDirectory(directory); - - using (var contents = new StreamWriter(path, false)) - { - foreach (string inputPath in uniqueInputFilePaths) - { - contents.WriteLine(inputPath); - } - } - } - - /// - /// Writes the paths to the output files to a text file. - /// - /// Path to write file. - /// Collection of files that were transferred to the output directory. - private void CreateOutputsFile(string path, IEnumerable trackedFiles) - { - var uniqueOutputPaths = new SortedSet(trackedFiles.Where(t => t.Clean).Select(t => t.Path), StringComparer.OrdinalIgnoreCase); - - if (!uniqueOutputPaths.Any()) - { - return; - } - - var directory = Path.GetDirectoryName(path); - Directory.CreateDirectory(directory); - - using (var outputs = new StreamWriter(path, false)) - { - //// Don't list files where the source is the same as the destination since - //// that might be the only place the file exists. The outputs file is often - //// used to delete stuff and losing the original source would be bad. - //var uniqueOutputPaths = new SortedSet(fileTransfers.Where(ft => !ft.Redundant).Select(ft => ft.Destination), StringComparer.OrdinalIgnoreCase); - - foreach (var outputPath in uniqueOutputPaths) - { - outputs.WriteLine(outputPath); - } - } - } - - /// - /// Writes the paths to the built output files to a text file. - /// - /// Path to write file. - /// Collection of files that were transferred to the output directory. - private void CreateBuiltOutputsFile(string path, IEnumerable trackedFiles) - { - var uniqueBuiltPaths = new SortedSet(trackedFiles.Where(t => t.Type == TrackedFileType.Final).Select(t => t.Path), StringComparer.OrdinalIgnoreCase); - - if (!uniqueBuiltPaths.Any()) - { - return; - } - - var directory = Path.GetDirectoryName(path); - Directory.CreateDirectory(directory); - - using (var outputs = new StreamWriter(path, false)) - { - foreach (var builtPath in uniqueBuiltPaths) - { - outputs.WriteLine(builtPath); - } - } - } - - private void CleanTempFiles(IEnumerable trackedFiles) - { - var uniqueTempPaths = new SortedSet(trackedFiles.Where(t => t.Type == TrackedFileType.Temporary).Select(t => t.Path), StringComparer.OrdinalIgnoreCase); - - if (!uniqueTempPaths.Any()) - { - return; - } - - var uniqueFolders = new SortedSet(StringComparer.OrdinalIgnoreCase) - { - this.IntermediateFolder - }; - - // Clean up temp files. - foreach (var tempPath in uniqueTempPaths) - { - try - { - this.SplitUniqueFolders(tempPath, uniqueFolders); - - File.Delete(tempPath); - } - catch // delete is best effort. - { - } - } - - // Clean up empty temp folders. - foreach (var folder in uniqueFolders.Reverse()) - { - try - { - Directory.Delete(folder); - } - catch // delete is best effort. - { - } - } - } - - private void SplitUniqueFolders(string tempPath, SortedSet uniqueFolders) - { - if (tempPath.StartsWith(this.IntermediateFolder, StringComparison.OrdinalIgnoreCase)) - { - var folder = Path.GetDirectoryName(tempPath).Substring(this.IntermediateFolder.Length); - - var parts = folder.Split(new[] { '\\', '/' }, StringSplitOptions.RemoveEmptyEntries); - - folder = this.IntermediateFolder; - - foreach (var part in parts) - { - folder = Path.Combine(folder, part); - - uniqueFolders.Add(folder); - } - } - } - } -} diff --git a/src/WixToolset.Core/LayoutContext.cs b/src/WixToolset.Core/LayoutContext.cs index 20d29b5f..b8a8635d 100644 --- a/src/WixToolset.Core/LayoutContext.cs +++ b/src/WixToolset.Core/LayoutContext.cs @@ -24,7 +24,7 @@ namespace WixToolset.Core public IEnumerable TrackedFiles { get; set; } - public string OutputPdbPath { get; set; } + public string IntermediateFolder { get; set; } public string ContentsFile { get; set; } diff --git a/src/WixToolset.Core/LayoutCreator.cs b/src/WixToolset.Core/LayoutCreator.cs new file mode 100644 index 00000000..684465d2 --- /dev/null +++ b/src/WixToolset.Core/LayoutCreator.cs @@ -0,0 +1,227 @@ +// 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.Core +{ + using System; + using System.Collections.Generic; + using System.IO; + using System.Linq; + using WixToolset.Core.Bind; + using WixToolset.Data; + using WixToolset.Extensibility.Data; + using WixToolset.Extensibility.Services; + + /// + /// Layout for the WiX toolset. + /// + internal class LayoutCreator : ILayoutCreator + { + internal LayoutCreator(IServiceProvider serviceProvider) + { + this.ServiceProvider = serviceProvider; + + this.Messaging = serviceProvider.GetService(); + } + + private IServiceProvider ServiceProvider { get; } + + private IMessaging Messaging { get; } + + public void Layout(ILayoutContext context) + { + // Pre-layout. + // + foreach (var extension in context.Extensions) + { + extension.PreLayout(context); + } + + try + { + // Final step in binding that transfers (moves/copies) all files generated into the appropriate + // location in the source image. + if (context.FileTransfers?.Any() == true) + { + this.Messaging.Write(VerboseMessages.LayingOutMedia()); + + var command = new TransferFilesCommand(this.Messaging, context.Extensions, context.FileTransfers, context.SuppressAclReset); + command.Execute(); + } + + if (context.TrackedFiles != null) + { + this.CleanTempFiles(context.IntermediateFolder, context.TrackedFiles); + } + } + finally + { + if (context.TrackedFiles != null) + { + if (!String.IsNullOrEmpty(context.ContentsFile)) + { + this.CreateContentsFile(context.ContentsFile, context.TrackedFiles); + } + + if (!String.IsNullOrEmpty(context.OutputsFile)) + { + this.CreateOutputsFile(context.OutputsFile, context.TrackedFiles); + } + + if (!String.IsNullOrEmpty(context.BuiltOutputsFile)) + { + this.CreateBuiltOutputsFile(context.BuiltOutputsFile, context.TrackedFiles); + } + } + } + + // Post-layout. + foreach (var extension in context.Extensions) + { + extension.PostLayout(); + } + } + + /// + /// Writes the paths to the content files to a text file. + /// + /// Path to write file. + /// Collection of paths to content files that will be written to file. + private void CreateContentsFile(string path, IEnumerable trackedFiles) + { + var uniqueInputFilePaths = new SortedSet(trackedFiles.Where(t => t.Type == TrackedFileType.Input).Select(t => t.Path), StringComparer.OrdinalIgnoreCase); + + if (!uniqueInputFilePaths.Any()) + { + return; + } + + var directory = Path.GetDirectoryName(path); + Directory.CreateDirectory(directory); + + using (var contents = new StreamWriter(path, false)) + { + foreach (var inputPath in uniqueInputFilePaths) + { + contents.WriteLine(inputPath); + } + } + } + + /// + /// Writes the paths to the output files to a text file. + /// + /// Path to write file. + /// Collection of files that were transferred to the output directory. + private void CreateOutputsFile(string path, IEnumerable trackedFiles) + { + var uniqueOutputPaths = new SortedSet(trackedFiles.Where(t => t.Clean).Select(t => t.Path), StringComparer.OrdinalIgnoreCase); + + if (!uniqueOutputPaths.Any()) + { + return; + } + + var directory = Path.GetDirectoryName(path); + Directory.CreateDirectory(directory); + + using (var outputs = new StreamWriter(path, false)) + { + //// Don't list files where the source is the same as the destination since + //// that might be the only place the file exists. The outputs file is often + //// used to delete stuff and losing the original source would be bad. + //var uniqueOutputPaths = new SortedSet(fileTransfers.Where(ft => !ft.Redundant).Select(ft => ft.Destination), StringComparer.OrdinalIgnoreCase); + + foreach (var outputPath in uniqueOutputPaths) + { + outputs.WriteLine(outputPath); + } + } + } + + /// + /// Writes the paths to the built output files to a text file. + /// + /// Path to write file. + /// Collection of files that were transferred to the output directory. + private void CreateBuiltOutputsFile(string path, IEnumerable trackedFiles) + { + var uniqueBuiltPaths = new SortedSet(trackedFiles.Where(t => t.Type == TrackedFileType.Final).Select(t => t.Path), StringComparer.OrdinalIgnoreCase); + + if (!uniqueBuiltPaths.Any()) + { + return; + } + + var directory = Path.GetDirectoryName(path); + Directory.CreateDirectory(directory); + + using (var outputs = new StreamWriter(path, false)) + { + foreach (var builtPath in uniqueBuiltPaths) + { + outputs.WriteLine(builtPath); + } + } + } + + private void CleanTempFiles(string intermediateFolder, IEnumerable trackedFiles) + { + var uniqueTempPaths = new SortedSet(trackedFiles.Where(t => t.Type == TrackedFileType.Temporary).Select(t => t.Path), StringComparer.OrdinalIgnoreCase); + + if (!uniqueTempPaths.Any()) + { + return; + } + + var uniqueFolders = new SortedSet(StringComparer.OrdinalIgnoreCase) + { + intermediateFolder + }; + + // Clean up temp files. + foreach (var tempPath in uniqueTempPaths) + { + try + { + this.SplitUniqueFolders(intermediateFolder, tempPath, uniqueFolders); + + File.Delete(tempPath); + } + catch // delete is best effort. + { + } + } + + // Clean up empty temp folders. + foreach (var folder in uniqueFolders.Reverse()) + { + try + { + Directory.Delete(folder); + } + catch // delete is best effort. + { + } + } + } + + private void SplitUniqueFolders(string intermediateFolder, string tempPath, SortedSet uniqueFolders) + { + if (tempPath.StartsWith(intermediateFolder, StringComparison.OrdinalIgnoreCase)) + { + var folder = Path.GetDirectoryName(tempPath).Substring(intermediateFolder.Length); + + var parts = folder.Split(new[] { '\\', '/' }, StringSplitOptions.RemoveEmptyEntries); + + folder = intermediateFolder; + + foreach (var part in parts) + { + folder = Path.Combine(folder, part); + + uniqueFolders.Add(folder); + } + } + } + } +} diff --git a/src/WixToolset.Core/Librarian.cs b/src/WixToolset.Core/Librarian.cs index abd6c844..5db4b219 100644 --- a/src/WixToolset.Core/Librarian.cs +++ b/src/WixToolset.Core/Librarian.cs @@ -8,14 +8,13 @@ namespace WixToolset.Core using WixToolset.Core.Bind; using WixToolset.Core.Link; using WixToolset.Data; - using WixToolset.Extensibility; using WixToolset.Extensibility.Data; using WixToolset.Extensibility.Services; /// /// Core librarian tool. /// - internal class Librarian + internal class Librarian : ILibrarian { internal Librarian(IServiceProvider serviceProvider) { @@ -28,42 +27,29 @@ namespace WixToolset.Core private IMessaging Messaging { get; } - private ILibraryContext Context { get; set; } - - public bool BindFiles { get; set; } - - public IEnumerable BindPaths { get; set; } - - public IEnumerable Localizations { get; set; } - - public IEnumerable Intermediates { get; set; } - /// /// Create a library by combining several intermediates (objects). /// /// The sections to combine into a library. /// Returns the new library. - public Intermediate Execute() + public Intermediate Combine(ILibraryContext context) { - this.Context = new LibraryContext(this.ServiceProvider); - this.Context.BindFiles = this.BindFiles; - this.Context.BindPaths = this.BindPaths; - this.Context.Extensions = this.ServiceProvider.GetService().Create(); - this.Context.Localizations = this.Localizations; - this.Context.LibraryId = Convert.ToBase64String(Guid.NewGuid().ToByteArray()).TrimEnd('=').Replace('+', '.').Replace('/', '_'); - this.Context.Intermediates = this.Intermediates; - - foreach (var extension in this.Context.Extensions) + if (String.IsNullOrEmpty(context.LibraryId)) + { + context.LibraryId = Convert.ToBase64String(Guid.NewGuid().ToByteArray()).TrimEnd('=').Replace('+', '.').Replace('/', '_'); + } + + foreach (var extension in context.Extensions) { - extension.PreCombine(this.Context); + extension.PreCombine(context); } Intermediate library = null; try { - var sections = this.Context.Intermediates.SelectMany(i => i.Sections).ToList(); + var sections = context.Intermediates.SelectMany(i => i.Sections).ToList(); - var collate = new CollateLocalizationsCommand(this.Messaging, this.Context.Localizations); + var collate = new CollateLocalizationsCommand(this.Messaging, context.Localizations); var localizationsByCulture = collate.Execute(); if (this.Messaging.EncounteredError) @@ -71,20 +57,20 @@ namespace WixToolset.Core return null; } - var embedFilePaths = this.ResolveFilePathsToEmbed(sections); + var embedFilePaths = this.ResolveFilePathsToEmbed(context, sections); foreach (var section in sections) { - section.LibraryId = this.Context.LibraryId; + section.LibraryId = context.LibraryId; } - library = new Intermediate(this.Context.LibraryId, sections, localizationsByCulture, embedFilePaths); + library = new Intermediate(context.LibraryId, sections, localizationsByCulture, embedFilePaths); this.Validate(library); } finally { - foreach (var extension in this.Context.Extensions) + foreach (var extension in context.Extensions) { extension.PostCombine(library); } @@ -99,7 +85,7 @@ namespace WixToolset.Core /// Library to validate. private void Validate(Intermediate library) { - FindEntrySectionAndLoadSymbolsCommand find = new FindEntrySectionAndLoadSymbolsCommand(this.Messaging, library.Sections); + var find = new FindEntrySectionAndLoadSymbolsCommand(this.Messaging, library.Sections); find.Execute(); // TODO: Consider bringing this sort of verification back. @@ -113,16 +99,16 @@ namespace WixToolset.Core // } } - private List ResolveFilePathsToEmbed(IEnumerable sections) + private List ResolveFilePathsToEmbed(ILibraryContext context, IEnumerable sections) { var embedFilePaths = new List(); // Resolve paths to files that are to be embedded in the library. - if (this.Context.BindFiles) + if (context.BindFiles) { var variableResolver = new WixVariableResolver(this.Messaging); - var fileResolver = new FileResolver(this.Context.BindPaths, this.Context.Extensions); + var fileResolver = new FileResolver(context.BindPaths, context.Extensions); foreach (var tuple in sections.SelectMany(s => s.Tuples)) { diff --git a/src/WixToolset.Core/Linker.cs b/src/WixToolset.Core/Linker.cs index 04188e53..80d57fa7 100644 --- a/src/WixToolset.Core/Linker.cs +++ b/src/WixToolset.Core/Linker.cs @@ -11,19 +11,18 @@ namespace WixToolset.Core using WixToolset.Core.Link; using WixToolset.Data; using WixToolset.Data.Tuples; - using WixToolset.Extensibility; using WixToolset.Extensibility.Data; using WixToolset.Extensibility.Services; /// /// Linker core of the WiX toolset. /// - internal class Linker + internal class Linker : ILinker { private static readonly char[] colonCharacter = ":".ToCharArray(); private static readonly string emptyGuid = Guid.Empty.ToString("B"); - private bool sectionIdOnRows; + private readonly bool sectionIdOnRows; /// /// Creates a linker. @@ -53,32 +52,20 @@ namespace WixToolset.Core /// The option to show pedantic messages. public bool ShowPedanticMessages { get; set; } - public OutputType OutputType { get; set; } - - public IEnumerable Intermediates { get; set; } - - public IEnumerable Libraries { get; set; } - - public ITupleDefinitionCreator TupleDefinitionCreator { get; set; } - /// /// Links a collection of sections into an output. /// /// The collection of sections to link together. /// Expected output type, based on output file extension provided to the linker. /// Output object from the linking. - public Intermediate Execute() + public Intermediate Link(ILinkContext context) { - var extensionManager = this.ServiceProvider.GetService(); - - var creator = this.TupleDefinitionCreator ?? this.ServiceProvider.GetService(); + this.Context = context; - this.Context = this.ServiceProvider.GetService(); - this.Context.Extensions = extensionManager.Create(); - this.Context.ExtensionData = extensionManager.Create(); - this.Context.ExpectedOutputType = this.OutputType; - this.Context.Intermediates = this.Intermediates.Concat(this.Libraries).ToList(); - this.Context.TupleDefinitionCreator = creator; + if (this.Context.TupleDefinitionCreator == null) + { + this.Context.TupleDefinitionCreator = this.ServiceProvider.GetService(); + } foreach (var extension in this.Context.Extensions) { @@ -117,7 +104,7 @@ namespace WixToolset.Core Hashtable generatedShortFileNames = new Hashtable(); #endif - Hashtable multipleFeatureComponents = new Hashtable(); + var multipleFeatureComponents = new Hashtable(); var wixVariables = new Dictionary(); @@ -238,7 +225,7 @@ namespace WixToolset.Core sectionCount++; var sectionId = section.Id; - if (null == sectionId && this.sectionIdOnRows) + if (null == sectionId && sectionIdOnRows) { sectionId = "wix.section." + sectionCount.ToString(CultureInfo.InvariantCulture); } @@ -256,12 +243,12 @@ namespace WixToolset.Core break; #endif - case TupleDefinitionType.Class: - if (SectionType.Product == resolvedSection.Type) - { - this.ResolveFeatures(tuple, 2, 11, componentsToFeatures, multipleFeatureComponents); - } - break; + case TupleDefinitionType.Class: + if (SectionType.Product == resolvedSection.Type) + { + this.ResolveFeatures(tuple, 2, 11, componentsToFeatures, multipleFeatureComponents); + } + break; #if MOVE_TO_BACKEND case "CustomAction": @@ -315,12 +302,12 @@ namespace WixToolset.Core } break; #endif - case TupleDefinitionType.Extension: - if (SectionType.Product == resolvedSection.Type) - { - this.ResolveFeatures(tuple, 1, 4, componentsToFeatures, multipleFeatureComponents); - } - break; + case TupleDefinitionType.Extension: + if (SectionType.Product == resolvedSection.Type) + { + this.ResolveFeatures(tuple, 1, 4, componentsToFeatures, multipleFeatureComponents); + } + break; #if MOVE_TO_BACKEND case TupleDefinitionType.ModuleSubstitution: @@ -332,12 +319,12 @@ namespace WixToolset.Core break; #endif - case TupleDefinitionType.MsiAssembly: - if (SectionType.Product == resolvedSection.Type) - { - this.ResolveFeatures(tuple, 0, 1, componentsToFeatures, multipleFeatureComponents); - } - break; + case TupleDefinitionType.MsiAssembly: + if (SectionType.Product == resolvedSection.Type) + { + this.ResolveFeatures(tuple, 0, 1, componentsToFeatures, multipleFeatureComponents); + } + break; #if MOVE_TO_BACKEND case "ProgId": @@ -359,26 +346,26 @@ namespace WixToolset.Core break; #endif - case TupleDefinitionType.PublishComponent: - if (SectionType.Product == resolvedSection.Type) - { - this.ResolveFeatures(tuple, 2, 4, componentsToFeatures, multipleFeatureComponents); - } - break; + case TupleDefinitionType.PublishComponent: + if (SectionType.Product == resolvedSection.Type) + { + this.ResolveFeatures(tuple, 2, 4, componentsToFeatures, multipleFeatureComponents); + } + break; - case TupleDefinitionType.Shortcut: - if (SectionType.Product == resolvedSection.Type) - { - this.ResolveFeatures(tuple, 3, 4, componentsToFeatures, multipleFeatureComponents); - } - break; + case TupleDefinitionType.Shortcut: + if (SectionType.Product == resolvedSection.Type) + { + this.ResolveFeatures(tuple, 3, 4, componentsToFeatures, multipleFeatureComponents); + } + break; - case TupleDefinitionType.TypeLib: - if (SectionType.Product == resolvedSection.Type) - { - this.ResolveFeatures(tuple, 2, 6, componentsToFeatures, multipleFeatureComponents); - } - break; + case TupleDefinitionType.TypeLib: + if (SectionType.Product == resolvedSection.Type) + { + this.ResolveFeatures(tuple, 2, 6, componentsToFeatures, multipleFeatureComponents); + } + break; #if SOLVE_CUSTOM_TABLE case "WixCustomTable": @@ -396,9 +383,9 @@ namespace WixToolset.Core break; #endif - case TupleDefinitionType.WixEnsureTable: - ensureTableRows.Add(tuple); - break; + case TupleDefinitionType.WixEnsureTable: + ensureTableRows.Add(tuple); + break; #if MOVE_TO_BACKEND @@ -421,45 +408,45 @@ namespace WixToolset.Core break; #endif - case TupleDefinitionType.WixMerge: - if (SectionType.Product == resolvedSection.Type) - { - this.ResolveFeatures(tuple, 0, 7, modulesToFeatures, null); - } - break; + case TupleDefinitionType.WixMerge: + if (SectionType.Product == resolvedSection.Type) + { + this.ResolveFeatures(tuple, 0, 7, modulesToFeatures, null); + } + break; - case TupleDefinitionType.WixComplexReference: - copyTuple = false; - break; + case TupleDefinitionType.WixComplexReference: + copyTuple = false; + break; - case TupleDefinitionType.WixSimpleReference: - copyTuple = false; - break; + case TupleDefinitionType.WixSimpleReference: + copyTuple = false; + break; - case TupleDefinitionType.WixVariable: - // check for colliding values and collect the wix variable rows - { - var row = (WixVariableTuple)tuple; + case TupleDefinitionType.WixVariable: + // check for colliding values and collect the wix variable rows + { + var row = (WixVariableTuple)tuple; - if (wixVariables.TryGetValue(row.WixVariable, out var collidingRow)) - { - if (collidingRow.Overridable && !row.Overridable) - { - wixVariables[row.WixVariable] = row; - } - else if (!row.Overridable || (collidingRow.Overridable && row.Overridable)) - { - this.OnMessage(ErrorMessages.WixVariableCollision(row.SourceLineNumbers, row.WixVariable)); - } - } - else - { - wixVariables.Add(row.WixVariable, row); - } + if (wixVariables.TryGetValue(row.WixVariable, out var collidingRow)) + { + if (collidingRow.Overridable && !row.Overridable) + { + wixVariables[row.WixVariable] = row; + } + else if (!row.Overridable || (collidingRow.Overridable && row.Overridable)) + { + this.OnMessage(ErrorMessages.WixVariableCollision(row.SourceLineNumbers, row.WixVariable)); } + } + else + { + wixVariables.Add(row.WixVariable, row); + } + } - copyTuple = false; - break; + copyTuple = false; + break; } if (copyTuple) @@ -624,7 +611,7 @@ namespace WixToolset.Core #endif //correct the section Id in FeatureComponents table - if (this.sectionIdOnRows) + if (sectionIdOnRows) { //var componentSectionIds = new Dictionary(); @@ -1152,7 +1139,7 @@ namespace WixToolset.Core /// Module to feature complex references. private void ProcessComplexReferences(IntermediateSection resolvedSection, IEnumerable sections, ISet referencedComponents, ConnectToFeatureCollection componentsToFeatures, ConnectToFeatureCollection featuresToFeatures, ConnectToFeatureCollection modulesToFeatures) { - Hashtable componentsToModules = new Hashtable(); + var componentsToModules = new Hashtable(); foreach (var section in sections) { @@ -1163,154 +1150,154 @@ namespace WixToolset.Core ConnectToFeature connection; switch (wixComplexReferenceRow.ParentType) { - case ComplexReferenceParentType.Feature: - switch (wixComplexReferenceRow.ChildType) + case ComplexReferenceParentType.Feature: + switch (wixComplexReferenceRow.ChildType) + { + case ComplexReferenceChildType.Component: + connection = componentsToFeatures[wixComplexReferenceRow.Child]; + if (null == connection) { - case ComplexReferenceChildType.Component: - connection = componentsToFeatures[wixComplexReferenceRow.Child]; - if (null == connection) - { - componentsToFeatures.Add(new ConnectToFeature(section, wixComplexReferenceRow.Child, wixComplexReferenceRow.Parent, wixComplexReferenceRow.IsPrimary)); - } - else if (wixComplexReferenceRow.IsPrimary) - { - if (connection.IsExplicitPrimaryFeature) - { - this.OnMessage(ErrorMessages.MultiplePrimaryReferences(wixComplexReferenceRow.SourceLineNumbers, wixComplexReferenceRow.ChildType.ToString(), wixComplexReferenceRow.Child, wixComplexReferenceRow.ParentType.ToString(), wixComplexReferenceRow.Parent, (null != connection.PrimaryFeature ? "Feature" : "Product"), connection.PrimaryFeature ?? resolvedSection.Id)); - continue; - } - else - { - connection.ConnectFeatures.Add(connection.PrimaryFeature); // move the guessed primary feature to the list of connects - connection.PrimaryFeature = wixComplexReferenceRow.Parent; // set the new primary feature - connection.IsExplicitPrimaryFeature = true; // and make sure we remember that we set it so we can fail if we try to set it again - } - } - else - { - connection.ConnectFeatures.Add(wixComplexReferenceRow.Parent); - } - - // add a row to the FeatureComponents table - var featureComponent = new FeatureComponentsTuple(); - featureComponent.Feature_ = wixComplexReferenceRow.Parent; - featureComponent.Component_ = wixComplexReferenceRow.Child; + componentsToFeatures.Add(new ConnectToFeature(section, wixComplexReferenceRow.Child, wixComplexReferenceRow.Parent, wixComplexReferenceRow.IsPrimary)); + } + else if (wixComplexReferenceRow.IsPrimary) + { + if (connection.IsExplicitPrimaryFeature) + { + this.OnMessage(ErrorMessages.MultiplePrimaryReferences(wixComplexReferenceRow.SourceLineNumbers, wixComplexReferenceRow.ChildType.ToString(), wixComplexReferenceRow.Child, wixComplexReferenceRow.ParentType.ToString(), wixComplexReferenceRow.Parent, (null != connection.PrimaryFeature ? "Feature" : "Product"), connection.PrimaryFeature ?? resolvedSection.Id)); + continue; + } + else + { + connection.ConnectFeatures.Add(connection.PrimaryFeature); // move the guessed primary feature to the list of connects + connection.PrimaryFeature = wixComplexReferenceRow.Parent; // set the new primary feature + connection.IsExplicitPrimaryFeature = true; // and make sure we remember that we set it so we can fail if we try to set it again + } + } + else + { + connection.ConnectFeatures.Add(wixComplexReferenceRow.Parent); + } - featureComponents.Add(featureComponent); + // add a row to the FeatureComponents table + var featureComponent = new FeatureComponentsTuple(); + featureComponent.Feature_ = wixComplexReferenceRow.Parent; + featureComponent.Component_ = wixComplexReferenceRow.Child; - // index the component for finding orphaned records - var symbolName = String.Concat("Component:", wixComplexReferenceRow.Child); - referencedComponents.Add(symbolName); + featureComponents.Add(featureComponent); - break; + // index the component for finding orphaned records + var symbolName = String.Concat("Component:", wixComplexReferenceRow.Child); + referencedComponents.Add(symbolName); - case ComplexReferenceChildType.Feature: - connection = featuresToFeatures[wixComplexReferenceRow.Child]; - if (null != connection) - { - this.OnMessage(ErrorMessages.MultiplePrimaryReferences(wixComplexReferenceRow.SourceLineNumbers, wixComplexReferenceRow.ChildType.ToString(), wixComplexReferenceRow.Child, wixComplexReferenceRow.ParentType.ToString(), wixComplexReferenceRow.Parent, (null != connection.PrimaryFeature ? "Feature" : "Product"), (null != connection.PrimaryFeature ? connection.PrimaryFeature : resolvedSection.Id))); - continue; - } + break; - featuresToFeatures.Add(new ConnectToFeature(section, wixComplexReferenceRow.Child, wixComplexReferenceRow.Parent, wixComplexReferenceRow.IsPrimary)); - break; + case ComplexReferenceChildType.Feature: + connection = featuresToFeatures[wixComplexReferenceRow.Child]; + if (null != connection) + { + this.OnMessage(ErrorMessages.MultiplePrimaryReferences(wixComplexReferenceRow.SourceLineNumbers, wixComplexReferenceRow.ChildType.ToString(), wixComplexReferenceRow.Child, wixComplexReferenceRow.ParentType.ToString(), wixComplexReferenceRow.Parent, (null != connection.PrimaryFeature ? "Feature" : "Product"), (null != connection.PrimaryFeature ? connection.PrimaryFeature : resolvedSection.Id))); + continue; + } - case ComplexReferenceChildType.Module: - connection = modulesToFeatures[wixComplexReferenceRow.Child]; - if (null == connection) - { - modulesToFeatures.Add(new ConnectToFeature(section, wixComplexReferenceRow.Child, wixComplexReferenceRow.Parent, wixComplexReferenceRow.IsPrimary)); - } - else if (wixComplexReferenceRow.IsPrimary) - { - if (connection.IsExplicitPrimaryFeature) - { - this.OnMessage(ErrorMessages.MultiplePrimaryReferences(wixComplexReferenceRow.SourceLineNumbers, wixComplexReferenceRow.ChildType.ToString(), wixComplexReferenceRow.Child, wixComplexReferenceRow.ParentType.ToString(), wixComplexReferenceRow.Parent, (null != connection.PrimaryFeature ? "Feature" : "Product"), (null != connection.PrimaryFeature ? connection.PrimaryFeature : resolvedSection.Id))); - continue; - } - else - { - connection.ConnectFeatures.Add(connection.PrimaryFeature); // move the guessed primary feature to the list of connects - connection.PrimaryFeature = wixComplexReferenceRow.Parent; // set the new primary feature - connection.IsExplicitPrimaryFeature = true; // and make sure we remember that we set it so we can fail if we try to set it again - } - } - else - { - connection.ConnectFeatures.Add(wixComplexReferenceRow.Parent); - } - break; + featuresToFeatures.Add(new ConnectToFeature(section, wixComplexReferenceRow.Child, wixComplexReferenceRow.Parent, wixComplexReferenceRow.IsPrimary)); + break; - default: - throw new InvalidOperationException(String.Format(CultureInfo.CurrentUICulture, WixStrings.EXP_UnexpectedComplexReferenceChildType, Enum.GetName(typeof(ComplexReferenceChildType), wixComplexReferenceRow.ChildType))); + case ComplexReferenceChildType.Module: + connection = modulesToFeatures[wixComplexReferenceRow.Child]; + if (null == connection) + { + modulesToFeatures.Add(new ConnectToFeature(section, wixComplexReferenceRow.Child, wixComplexReferenceRow.Parent, wixComplexReferenceRow.IsPrimary)); + } + else if (wixComplexReferenceRow.IsPrimary) + { + if (connection.IsExplicitPrimaryFeature) + { + this.OnMessage(ErrorMessages.MultiplePrimaryReferences(wixComplexReferenceRow.SourceLineNumbers, wixComplexReferenceRow.ChildType.ToString(), wixComplexReferenceRow.Child, wixComplexReferenceRow.ParentType.ToString(), wixComplexReferenceRow.Parent, (null != connection.PrimaryFeature ? "Feature" : "Product"), (null != connection.PrimaryFeature ? connection.PrimaryFeature : resolvedSection.Id))); + continue; + } + else + { + connection.ConnectFeatures.Add(connection.PrimaryFeature); // move the guessed primary feature to the list of connects + connection.PrimaryFeature = wixComplexReferenceRow.Parent; // set the new primary feature + connection.IsExplicitPrimaryFeature = true; // and make sure we remember that we set it so we can fail if we try to set it again + } + } + else + { + connection.ConnectFeatures.Add(wixComplexReferenceRow.Parent); } break; - case ComplexReferenceParentType.Module: - switch (wixComplexReferenceRow.ChildType) - { - case ComplexReferenceChildType.Component: - if (componentsToModules.ContainsKey(wixComplexReferenceRow.Child)) - { - this.OnMessage(ErrorMessages.ComponentReferencedTwice(wixComplexReferenceRow.SourceLineNumbers, wixComplexReferenceRow.Child)); - continue; - } - else - { - componentsToModules.Add(wixComplexReferenceRow.Child, wixComplexReferenceRow); // should always be new + default: + throw new InvalidOperationException(String.Format(CultureInfo.CurrentUICulture, WixStrings.EXP_UnexpectedComplexReferenceChildType, Enum.GetName(typeof(ComplexReferenceChildType), wixComplexReferenceRow.ChildType))); + } + break; - // add a row to the ModuleComponents table - var moduleComponent = new ModuleComponentsTuple(); - moduleComponent.Component = wixComplexReferenceRow.Child; - moduleComponent.ModuleID = wixComplexReferenceRow.Parent; - moduleComponent.Language = Convert.ToInt32(wixComplexReferenceRow.ParentLanguage); - } + case ComplexReferenceParentType.Module: + switch (wixComplexReferenceRow.ChildType) + { + case ComplexReferenceChildType.Component: + if (componentsToModules.ContainsKey(wixComplexReferenceRow.Child)) + { + this.OnMessage(ErrorMessages.ComponentReferencedTwice(wixComplexReferenceRow.SourceLineNumbers, wixComplexReferenceRow.Child)); + continue; + } + else + { + componentsToModules.Add(wixComplexReferenceRow.Child, wixComplexReferenceRow); // should always be new - // index the component for finding orphaned records - string componentSymbolName = String.Concat("Component:", wixComplexReferenceRow.Child); - referencedComponents.Add(componentSymbolName); + // add a row to the ModuleComponents table + var moduleComponent = new ModuleComponentsTuple(); + moduleComponent.Component = wixComplexReferenceRow.Child; + moduleComponent.ModuleID = wixComplexReferenceRow.Parent; + moduleComponent.Language = Convert.ToInt32(wixComplexReferenceRow.ParentLanguage); + } - break; + // index the component for finding orphaned records + var componentSymbolName = String.Concat("Component:", wixComplexReferenceRow.Child); + referencedComponents.Add(componentSymbolName); - default: - throw new InvalidOperationException(String.Format(CultureInfo.CurrentUICulture, WixStrings.EXP_UnexpectedComplexReferenceChildType, Enum.GetName(typeof(ComplexReferenceChildType), wixComplexReferenceRow.ChildType))); - } break; - case ComplexReferenceParentType.Patch: - switch (wixComplexReferenceRow.ChildType) - { - case ComplexReferenceChildType.PatchFamily: - case ComplexReferenceChildType.PatchFamilyGroup: - break; + default: + throw new InvalidOperationException(String.Format(CultureInfo.CurrentUICulture, WixStrings.EXP_UnexpectedComplexReferenceChildType, Enum.GetName(typeof(ComplexReferenceChildType), wixComplexReferenceRow.ChildType))); + } + break; - default: - throw new InvalidOperationException(String.Format(CultureInfo.CurrentUICulture, WixStrings.EXP_UnexpectedComplexReferenceChildType, Enum.GetName(typeof(ComplexReferenceChildType), wixComplexReferenceRow.ChildType))); - } + case ComplexReferenceParentType.Patch: + switch (wixComplexReferenceRow.ChildType) + { + case ComplexReferenceChildType.PatchFamily: + case ComplexReferenceChildType.PatchFamilyGroup: break; - case ComplexReferenceParentType.Product: - switch (wixComplexReferenceRow.ChildType) - { - case ComplexReferenceChildType.Feature: - connection = featuresToFeatures[wixComplexReferenceRow.Child]; - if (null != connection) - { - this.OnMessage(ErrorMessages.MultiplePrimaryReferences(wixComplexReferenceRow.SourceLineNumbers, wixComplexReferenceRow.ChildType.ToString(), wixComplexReferenceRow.Child, wixComplexReferenceRow.ParentType.ToString(), wixComplexReferenceRow.Parent, (null != connection.PrimaryFeature ? "Feature" : "Product"), (null != connection.PrimaryFeature ? connection.PrimaryFeature : resolvedSection.Id))); - continue; - } - - featuresToFeatures.Add(new ConnectToFeature(section, wixComplexReferenceRow.Child, null, wixComplexReferenceRow.IsPrimary)); - break; + default: + throw new InvalidOperationException(String.Format(CultureInfo.CurrentUICulture, WixStrings.EXP_UnexpectedComplexReferenceChildType, Enum.GetName(typeof(ComplexReferenceChildType), wixComplexReferenceRow.ChildType))); + } + break; - default: - throw new InvalidOperationException(String.Format(CultureInfo.CurrentUICulture, WixStrings.EXP_UnexpectedComplexReferenceChildType, Enum.GetName(typeof(ComplexReferenceChildType), wixComplexReferenceRow.ChildType))); + case ComplexReferenceParentType.Product: + switch (wixComplexReferenceRow.ChildType) + { + case ComplexReferenceChildType.Feature: + connection = featuresToFeatures[wixComplexReferenceRow.Child]; + if (null != connection) + { + this.OnMessage(ErrorMessages.MultiplePrimaryReferences(wixComplexReferenceRow.SourceLineNumbers, wixComplexReferenceRow.ChildType.ToString(), wixComplexReferenceRow.Child, wixComplexReferenceRow.ParentType.ToString(), wixComplexReferenceRow.Parent, (null != connection.PrimaryFeature ? "Feature" : "Product"), (null != connection.PrimaryFeature ? connection.PrimaryFeature : resolvedSection.Id))); + continue; } + + featuresToFeatures.Add(new ConnectToFeature(section, wixComplexReferenceRow.Child, null, wixComplexReferenceRow.IsPrimary)); break; default: - // Note: Groups have been processed before getting here so they are not handled by any case above. - throw new InvalidOperationException(String.Format(CultureInfo.CurrentUICulture, WixStrings.EXP_UnexpectedComplexReferenceChildType, Enum.GetName(typeof(ComplexReferenceParentType), wixComplexReferenceRow.ParentType))); + throw new InvalidOperationException(String.Format(CultureInfo.CurrentUICulture, WixStrings.EXP_UnexpectedComplexReferenceChildType, Enum.GetName(typeof(ComplexReferenceChildType), wixComplexReferenceRow.ChildType))); + } + break; + + default: + // Note: Groups have been processed before getting here so they are not handled by any case above. + throw new InvalidOperationException(String.Format(CultureInfo.CurrentUICulture, WixStrings.EXP_UnexpectedComplexReferenceChildType, Enum.GetName(typeof(ComplexReferenceParentType), wixComplexReferenceRow.ParentType))); } } @@ -1341,7 +1328,7 @@ namespace WixToolset.Core foreach (var section in sections) { // Count down because we'll sometimes remove items from the list. - for (int i = section.Tuples.Count - 1; i >= 0; --i) + for (var i = section.Tuples.Count - 1; i >= 0; --i) { // Only process the "grouping parents" such as FeatureGroup, ComponentGroup, Feature, // and Module. Non-grouping complex references are simple and @@ -1354,7 +1341,7 @@ namespace WixToolset.Core ComplexReferenceParentType.PatchFamilyGroup == wixComplexReferenceRow.ParentType || ComplexReferenceParentType.Product == wixComplexReferenceRow.ParentType)) { - var parentTypeAndId = CombineTypeAndId(wixComplexReferenceRow.ParentType, wixComplexReferenceRow.Parent); + var parentTypeAndId = this.CombineTypeAndId(wixComplexReferenceRow.ParentType, wixComplexReferenceRow.Parent); // Group all complex references with a common parent // together so we can find them quickly while processing in @@ -1402,7 +1389,7 @@ namespace WixToolset.Core // complex references should all be flattened. var keys = parentGroupsNeedingProcessing.Keys.ToList(); - foreach (string key in keys) + foreach (var key in keys) { if (parentGroupsNeedingProcessing.ContainsKey(key)) { @@ -1466,14 +1453,14 @@ namespace WixToolset.Core foreach (var wixComplexReferenceRow in referencesToParent) { Debug.Assert(ComplexReferenceParentType.ComponentGroup == wixComplexReferenceRow.ParentType || ComplexReferenceParentType.FeatureGroup == wixComplexReferenceRow.ParentType || ComplexReferenceParentType.Feature == wixComplexReferenceRow.ParentType || ComplexReferenceParentType.Module == wixComplexReferenceRow.ParentType || ComplexReferenceParentType.Product == wixComplexReferenceRow.ParentType || ComplexReferenceParentType.PatchFamilyGroup == wixComplexReferenceRow.ParentType || ComplexReferenceParentType.Patch == wixComplexReferenceRow.ParentType); - Debug.Assert(parentTypeAndId == CombineTypeAndId(wixComplexReferenceRow.ParentType, wixComplexReferenceRow.Parent)); + Debug.Assert(parentTypeAndId == this.CombineTypeAndId(wixComplexReferenceRow.ParentType, wixComplexReferenceRow.Parent)); // We are only interested processing when the child is a group. if ((ComplexReferenceChildType.ComponentGroup == wixComplexReferenceRow.ChildType) || (ComplexReferenceChildType.FeatureGroup == wixComplexReferenceRow.ChildType) || (ComplexReferenceChildType.PatchFamilyGroup == wixComplexReferenceRow.ChildType)) { - string childTypeAndId = CombineTypeAndId(wixComplexReferenceRow.ChildType, wixComplexReferenceRow.Child); + var childTypeAndId = this.CombineTypeAndId(wixComplexReferenceRow.ChildType, wixComplexReferenceRow.Child); if (loopDetector.Contains(childTypeAndId)) { // Create a comma delimited list of the references that participate in the @@ -1531,7 +1518,7 @@ namespace WixToolset.Core // duplicate complex references that occurred during the merge. referencesToParent.AddRange(allNewChildComplexReferences); referencesToParent.Sort(ComplexReferenceComparision); - for (int i = referencesToParent.Count - 1; i >= 0; --i) + for (var i = referencesToParent.Count - 1; i >= 0; --i) { var wixComplexReferenceRow = referencesToParent[i]; @@ -1716,7 +1703,7 @@ namespace WixToolset.Core if (emptyGuid == featureId) { - ConnectToFeature connection = connectToFeatures[connectionId]; + var connection = connectToFeatures[connectionId]; if (null == connection) { diff --git a/src/WixToolset.Core/PreprocessContext.cs b/src/WixToolset.Core/PreprocessContext.cs index 151506e2..749bf213 100644 --- a/src/WixToolset.Core/PreprocessContext.cs +++ b/src/WixToolset.Core/PreprocessContext.cs @@ -21,9 +21,9 @@ namespace WixToolset.Core public Platform Platform { get; set; } - public IList IncludeSearchPaths { get; set; } + public IEnumerable IncludeSearchPaths { get; set; } - public string SourceFile { get; set; } + public string SourcePath { get; set; } public IDictionary Variables { get; set; } diff --git a/src/WixToolset.Core/Preprocessor.cs b/src/WixToolset.Core/Preprocessor.cs index 9f0ab1bb..5a9cf115 100644 --- a/src/WixToolset.Core/Preprocessor.cs +++ b/src/WixToolset.Core/Preprocessor.cs @@ -6,7 +6,6 @@ namespace WixToolset.Core using System.Collections.Generic; using System.Globalization; using System.IO; - using System.Linq; using System.Text; using System.Text.RegularExpressions; using System.Xml; @@ -20,7 +19,7 @@ namespace WixToolset.Core /// /// Preprocessor object /// - internal class Preprocessor + internal class Preprocessor : IPreprocessor { private static readonly Regex DefineRegex = new Regex(@"^\s*(?.+?)\s*(=\s*(?.+?)\s*)?$", RegexOptions.Compiled | RegexOptions.Singleline | RegexOptions.ExplicitCapture); private static readonly Regex PragmaRegex = new Regex(@"^\s*(?.+?)(?[\s\(].+?)?$", RegexOptions.Compiled | RegexOptions.Singleline | RegexOptions.ExplicitCapture); @@ -30,6 +29,7 @@ namespace WixToolset.Core ValidationFlags = System.Xml.Schema.XmlSchemaValidationFlags.None, XmlResolver = null, }; + private static readonly XmlReaderSettings FragmentXmlReaderSettings = new XmlReaderSettings() { ConformanceLevel = ConformanceLevel.Fragment, @@ -44,14 +44,6 @@ namespace WixToolset.Core this.Messaging = this.ServiceProvider.GetService(); } - public IEnumerable IncludeSearchPaths { get; set; } - - public Platform Platform { get; set; } - - public string SourcePath { get; set; } - - public IDictionary Variables { get; set; } - private IServiceProvider ServiceProvider { get; } private IMessaging Messaging { get; } @@ -108,19 +100,21 @@ namespace WixToolset.Core /// /// The preprocessing context. /// XDocument with the postprocessed data. - public XDocument Execute() + public XDocument Preprocess(IPreprocessContext context) { - this.Context = this.CreateContext(); + this.Context = context; + this.Context.CurrentSourceLineNumber = new SourceLineNumber(context.SourcePath); + this.Context.Variables = this.Context.Variables == null ? new Dictionary() : new Dictionary(this.Context.Variables); this.PreProcess(); XDocument document; - using (XmlReader reader = XmlReader.Create(this.Context.SourceFile, DocumentXmlReaderSettings)) + using (var reader = XmlReader.Create(this.Context.SourcePath, DocumentXmlReaderSettings)) { document = this.Process(reader); } - return PostProcess(document); + return this.PostProcess(document); } /// @@ -129,21 +123,23 @@ namespace WixToolset.Core /// The preprocessing context. /// XmlReader to processing the context. /// XDocument with the postprocessed data. - public XDocument Execute(XmlReader reader) + public XDocument Preprocess(IPreprocessContext context, XmlReader reader) { - if (String.IsNullOrEmpty(this.SourcePath) && !String.IsNullOrEmpty(reader.BaseURI)) + if (String.IsNullOrEmpty(context.SourcePath) && !String.IsNullOrEmpty(reader.BaseURI)) { var uri = new Uri(reader.BaseURI); - this.SourcePath = uri.AbsolutePath; + context.SourcePath = uri.AbsolutePath; } - this.Context = this.CreateContext(); + this.Context = context; + this.Context.CurrentSourceLineNumber = new SourceLineNumber(context.SourcePath); + this.Context.Variables = this.Context.Variables == null ? new Dictionary() : new Dictionary(this.Context.Variables); this.PreProcess(); var document = this.Process(reader); - return PostProcess(document); + return this.PostProcess(document); } /// @@ -160,13 +156,13 @@ namespace WixToolset.Core this.CurrentFileStack.Push(this.Helper.GetVariableValue(this.Context, "sys", "SOURCEFILEDIR")); // Process the reader into the output. - XDocument output = new XDocument(); + var output = new XDocument(); try { this.PreprocessReader(false, reader, output, 0); // Fire event with post-processed document. - this.ProcessedStream?.Invoke(this, new ProcessedStreamEventArgs(this.Context.SourceFile, output)); + this.ProcessedStream?.Invoke(this, new ProcessedStreamEventArgs(this.Context.SourcePath, output)); } catch (XmlException e) { @@ -221,8 +217,8 @@ namespace WixToolset.Core return false; } - int numQuotes = 0; - int tmpIndex = 0; + var numQuotes = 0; + var tmpIndex = 0; while (-1 != (tmpIndex = expression.IndexOf('\"', tmpIndex, index - tmpIndex))) { numQuotes++; @@ -250,26 +246,26 @@ namespace WixToolset.Core expression = expression.ToUpperInvariant(); switch (operation) { - case PreprocessorOperation.Not: - if (expression.StartsWith("NOT ", StringComparison.Ordinal) || expression.StartsWith("NOT(", StringComparison.Ordinal)) - { - return true; - } - break; - case PreprocessorOperation.And: - if (expression.StartsWith("AND ", StringComparison.Ordinal) || expression.StartsWith("AND(", StringComparison.Ordinal)) - { - return true; - } - break; - case PreprocessorOperation.Or: - if (expression.StartsWith("OR ", StringComparison.Ordinal) || expression.StartsWith("OR(", StringComparison.Ordinal)) - { - return true; - } - break; - default: - break; + case PreprocessorOperation.Not: + if (expression.StartsWith("NOT ", StringComparison.Ordinal) || expression.StartsWith("NOT(", StringComparison.Ordinal)) + { + return true; + } + break; + case PreprocessorOperation.And: + if (expression.StartsWith("AND ", StringComparison.Ordinal) || expression.StartsWith("AND(", StringComparison.Ordinal)) + { + return true; + } + break; + case PreprocessorOperation.Or: + if (expression.StartsWith("OR ", StringComparison.Ordinal) || expression.StartsWith("OR(", StringComparison.Ordinal)) + { + return true; + } + break; + default: + break; } return false; } @@ -283,11 +279,11 @@ namespace WixToolset.Core /// Original offset for the line numbers being processed. private void PreprocessReader(bool include, XmlReader reader, XContainer container, int offset) { - XContainer currentContainer = container; - Stack containerStack = new Stack(); + var currentContainer = container; + var containerStack = new Stack(); - IfContext ifContext = new IfContext(true, true, IfState.Unknown); // start by assuming we want to keep the nodes in the source code - Stack ifStack = new Stack(); + var ifContext = new IfContext(true, true, IfState.Unknown); // start by assuming we want to keep the nodes in the source code + var ifStack = new Stack(); // process the reader into the writer while (reader.Read()) @@ -300,102 +296,102 @@ namespace WixToolset.Core // check for changes in conditional processing if (XmlNodeType.ProcessingInstruction == reader.NodeType) { - bool ignore = false; + var ignore = false; string name = null; switch (reader.LocalName) { - case "if": - ifStack.Push(ifContext); - if (ifContext.IsTrue) - { - ifContext = new IfContext(ifContext.IsTrue & ifContext.Active, this.EvaluateExpression(reader.Value), IfState.If); - } - else // Use a default IfContext object so we don't try to evaluate the expression if the context isn't true - { - ifContext = new IfContext(); - } - ignore = true; - break; + case "if": + ifStack.Push(ifContext); + if (ifContext.IsTrue) + { + ifContext = new IfContext(ifContext.IsTrue & ifContext.Active, this.EvaluateExpression(reader.Value), IfState.If); + } + else // Use a default IfContext object so we don't try to evaluate the expression if the context isn't true + { + ifContext = new IfContext(); + } + ignore = true; + break; - case "ifdef": - ifStack.Push(ifContext); - name = reader.Value.Trim(); - if (ifContext.IsTrue) - { - ifContext = new IfContext(ifContext.IsTrue & ifContext.Active, (null != this.Helper.GetVariableValue(this.Context, name, true)), IfState.If); - } - else // Use a default IfContext object so we don't try to evaluate the expression if the context isn't true - { - ifContext = new IfContext(); - } - ignore = true; - this.IfDef?.Invoke(this, new IfDefEventArgs(sourceLineNumbers, true, ifContext.IsTrue, name)); - break; + case "ifdef": + ifStack.Push(ifContext); + name = reader.Value.Trim(); + if (ifContext.IsTrue) + { + ifContext = new IfContext(ifContext.IsTrue & ifContext.Active, (null != this.Helper.GetVariableValue(this.Context, name, true)), IfState.If); + } + else // Use a default IfContext object so we don't try to evaluate the expression if the context isn't true + { + ifContext = new IfContext(); + } + ignore = true; + this.IfDef?.Invoke(this, new IfDefEventArgs(sourceLineNumbers, true, ifContext.IsTrue, name)); + break; - case "ifndef": - ifStack.Push(ifContext); - name = reader.Value.Trim(); - if (ifContext.IsTrue) - { - ifContext = new IfContext(ifContext.IsTrue & ifContext.Active, (null == this.Helper.GetVariableValue(this.Context, name, true)), IfState.If); - } - else // Use a default IfContext object so we don't try to evaluate the expression if the context isn't true - { - ifContext = new IfContext(); - } - ignore = true; - this.IfDef?.Invoke(this, new IfDefEventArgs(sourceLineNumbers, false, !ifContext.IsTrue, name)); - break; + case "ifndef": + ifStack.Push(ifContext); + name = reader.Value.Trim(); + if (ifContext.IsTrue) + { + ifContext = new IfContext(ifContext.IsTrue & ifContext.Active, (null == this.Helper.GetVariableValue(this.Context, name, true)), IfState.If); + } + else // Use a default IfContext object so we don't try to evaluate the expression if the context isn't true + { + ifContext = new IfContext(); + } + ignore = true; + this.IfDef?.Invoke(this, new IfDefEventArgs(sourceLineNumbers, false, !ifContext.IsTrue, name)); + break; - case "elseif": - if (0 == ifStack.Count) - { - throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "if", "elseif")); - } + case "elseif": + if (0 == ifStack.Count) + { + throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "if", "elseif")); + } - if (IfState.If != ifContext.IfState && IfState.ElseIf != ifContext.IfState) - { - throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "if", "elseif")); - } + if (IfState.If != ifContext.IfState && IfState.ElseIf != ifContext.IfState) + { + throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "if", "elseif")); + } - ifContext.IfState = IfState.ElseIf; // we're now in an elseif - if (!ifContext.WasEverTrue) // if we've never evaluated the if context to true, then we can try this test - { - ifContext.IsTrue = this.EvaluateExpression(reader.Value); - } - else if (ifContext.IsTrue) - { - ifContext.IsTrue = false; - } - ignore = true; - break; + ifContext.IfState = IfState.ElseIf; // we're now in an elseif + if (!ifContext.WasEverTrue) // if we've never evaluated the if context to true, then we can try this test + { + ifContext.IsTrue = this.EvaluateExpression(reader.Value); + } + else if (ifContext.IsTrue) + { + ifContext.IsTrue = false; + } + ignore = true; + break; - case "else": - if (0 == ifStack.Count) - { - throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "if", "else")); - } + case "else": + if (0 == ifStack.Count) + { + throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "if", "else")); + } - if (IfState.If != ifContext.IfState && IfState.ElseIf != ifContext.IfState) - { - throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "if", "else")); - } + if (IfState.If != ifContext.IfState && IfState.ElseIf != ifContext.IfState) + { + throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "if", "else")); + } - ifContext.IfState = IfState.Else; // we're now in an else - ifContext.IsTrue = !ifContext.WasEverTrue; // if we were never true, we can be true now - ignore = true; - break; + ifContext.IfState = IfState.Else; // we're now in an else + ifContext.IsTrue = !ifContext.WasEverTrue; // if we were never true, we can be true now + ignore = true; + break; - case "endif": - if (0 == ifStack.Count) - { - throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "if", "endif")); - } + case "endif": + if (0 == ifStack.Count) + { + throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "if", "endif")); + } - ifContext = (IfContext)ifStack.Pop(); - ignore = true; - break; + ifContext = ifStack.Pop(); + ignore = true; + break; } if (ignore) // ignore this node since we just handled it above @@ -411,134 +407,134 @@ namespace WixToolset.Core switch (reader.NodeType) { - case XmlNodeType.XmlDeclaration: - XDocument document = currentContainer as XDocument; - if (null != document) + case XmlNodeType.XmlDeclaration: + var document = currentContainer as XDocument; + if (null != document) + { + document.Declaration = new XDeclaration(null, null, null); + while (reader.MoveToNextAttribute()) { - document.Declaration = new XDeclaration(null, null, null); - while (reader.MoveToNextAttribute()) + switch (reader.LocalName) { - switch (reader.LocalName) - { - case "version": - document.Declaration.Version = reader.Value; - break; - - case "encoding": - document.Declaration.Encoding = reader.Value; - break; - - case "standalone": - document.Declaration.Standalone = reader.Value; - break; - } - } - - } - //else - //{ - // display an error? Can this happen? - //} - break; - - case XmlNodeType.ProcessingInstruction: - switch (reader.LocalName) - { - case "define": - this.PreprocessDefine(reader.Value); - break; - - case "error": - this.PreprocessError(reader.Value); - break; - - case "warning": - this.PreprocessWarning(reader.Value); + case "version": + document.Declaration.Version = reader.Value; break; - case "undef": - this.PreprocessUndef(reader.Value); + case "encoding": + document.Declaration.Encoding = reader.Value; break; - case "include": - this.UpdateCurrentLineNumber(reader, offset); - this.PreprocessInclude(reader.Value, currentContainer); + case "standalone": + document.Declaration.Standalone = reader.Value; break; + } + } - case "foreach": - this.PreprocessForeach(reader, currentContainer, offset); - break; - - case "endforeach": // endforeach is handled in PreprocessForeach, so seeing it here is an error - throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "foreach", "endforeach")); - - case "pragma": - this.PreprocessPragma(reader.Value, currentContainer); - break; + } + //else + //{ + // display an error? Can this happen? + //} + break; - default: - // unknown processing instructions are currently ignored - break; - } + case XmlNodeType.ProcessingInstruction: + switch (reader.LocalName) + { + case "define": + this.PreprocessDefine(reader.Value); break; - case XmlNodeType.Element: - if (0 < this.IncludeNextStack.Count && this.IncludeNextStack.Peek()) - { - if ("Include" != reader.LocalName) - { - this.Messaging.Write(ErrorMessages.InvalidDocumentElement(sourceLineNumbers, reader.Name, "include", "Include")); - } + case "error": + this.PreprocessError(reader.Value); + break; - this.IncludeNextStack.Pop(); - this.IncludeNextStack.Push(false); - break; - } + case "warning": + this.PreprocessWarning(reader.Value); + break; - var empty = reader.IsEmptyElement; - var ns = XNamespace.Get(reader.NamespaceURI); - var element = new XElement(ns + reader.LocalName); - currentContainer.Add(element); + case "undef": + this.PreprocessUndef(reader.Value); + break; + case "include": this.UpdateCurrentLineNumber(reader, offset); - element.AddAnnotation(sourceLineNumbers); + this.PreprocessInclude(reader.Value, currentContainer); + break; - while (reader.MoveToNextAttribute()) - { - var value = this.Helper.PreprocessString(this.Context, reader.Value); + case "foreach": + this.PreprocessForeach(reader, currentContainer, offset); + break; - var attribNamespace = XNamespace.Get(reader.NamespaceURI); - attribNamespace = XNamespace.Xmlns == attribNamespace && reader.LocalName.Equals("xmlns") ? XNamespace.None : attribNamespace; + case "endforeach": // endforeach is handled in PreprocessForeach, so seeing it here is an error + throw new WixException(ErrorMessages.UnmatchedPreprocessorInstruction(sourceLineNumbers, "foreach", "endforeach")); - element.Add(new XAttribute(attribNamespace + reader.LocalName, value)); - } + case "pragma": + this.PreprocessPragma(reader.Value, currentContainer); + break; - if (!empty) - { - containerStack.Push(currentContainer); - currentContainer = element; - } + default: + // unknown processing instructions are currently ignored break; + } + break; - case XmlNodeType.EndElement: - if (0 < reader.Depth || !include) + case XmlNodeType.Element: + if (0 < this.IncludeNextStack.Count && this.IncludeNextStack.Peek()) + { + if ("Include" != reader.LocalName) { - currentContainer = containerStack.Pop(); + this.Messaging.Write(ErrorMessages.InvalidDocumentElement(sourceLineNumbers, reader.Name, "include", "Include")); } - break; - case XmlNodeType.Text: - string postprocessedText = this.Helper.PreprocessString(this.Context, reader.Value); - currentContainer.Add(postprocessedText); + this.IncludeNextStack.Pop(); + this.IncludeNextStack.Push(false); break; + } - case XmlNodeType.CDATA: - string postprocessedValue = this.Helper.PreprocessString(this.Context, reader.Value); - currentContainer.Add(new XCData(postprocessedValue)); - break; + var empty = reader.IsEmptyElement; + var ns = XNamespace.Get(reader.NamespaceURI); + var element = new XElement(ns + reader.LocalName); + currentContainer.Add(element); - default: - break; + this.UpdateCurrentLineNumber(reader, offset); + element.AddAnnotation(sourceLineNumbers); + + while (reader.MoveToNextAttribute()) + { + var value = this.Helper.PreprocessString(this.Context, reader.Value); + + var attribNamespace = XNamespace.Get(reader.NamespaceURI); + attribNamespace = XNamespace.Xmlns == attribNamespace && reader.LocalName.Equals("xmlns") ? XNamespace.None : attribNamespace; + + element.Add(new XAttribute(attribNamespace + reader.LocalName, value)); + } + + if (!empty) + { + containerStack.Push(currentContainer); + currentContainer = element; + } + break; + + case XmlNodeType.EndElement: + if (0 < reader.Depth || !include) + { + currentContainer = containerStack.Pop(); + } + break; + + case XmlNodeType.Text: + var postprocessedText = this.Helper.PreprocessString(this.Context, reader.Value); + currentContainer.Add(postprocessedText); + break; + + case XmlNodeType.CDATA: + var postprocessedValue = this.Helper.PreprocessString(this.Context, reader.Value); + currentContainer.Add(new XCData(postprocessedValue)); + break; + + default: + break; } } @@ -652,7 +648,7 @@ namespace WixToolset.Core throw new WixException(ErrorMessages.FileNotFound(sourceLineNumbers, includePath, "include")); } - using (XmlReader reader = XmlReader.Create(includeFile, DocumentXmlReaderSettings)) + using (var reader = XmlReader.Create(includeFile, DocumentXmlReaderSettings)) { this.PushInclude(includeFile); @@ -689,13 +685,13 @@ namespace WixToolset.Core } // parse out the variable name - string varName = reader.Value.Substring(0, indexOfInToken).Trim(); - string varValuesString = reader.Value.Substring(indexOfInToken + 4).Trim(); + var varName = reader.Value.Substring(0, indexOfInToken).Trim(); + var varValuesString = reader.Value.Substring(indexOfInToken + 4).Trim(); // preprocess the variable values string because it might be a variable itself varValuesString = this.Helper.PreprocessString(this.Context, varValuesString); - string[] varValues = varValuesString.Split(';'); + var varValues = varValuesString.Split(';'); // go through all the empty strings while (reader.Read() && XmlNodeType.Whitespace == reader.NodeType) @@ -703,44 +699,44 @@ namespace WixToolset.Core } // get the offset of this xml fragment (for some reason its always off by 1) - IXmlLineInfo lineInfoReader = reader as IXmlLineInfo; + var lineInfoReader = reader as IXmlLineInfo; if (null != lineInfoReader) { offset += lineInfoReader.LineNumber - 1; } - XmlTextReader textReader = reader as XmlTextReader; + var textReader = reader as XmlTextReader; // dump the xml to a string (maintaining whitespace if possible) if (null != textReader) { textReader.WhitespaceHandling = WhitespaceHandling.All; } - StringBuilder fragmentBuilder = new StringBuilder(); - int nestedForeachCount = 1; + var fragmentBuilder = new StringBuilder(); + var nestedForeachCount = 1; while (nestedForeachCount != 0) { if (reader.NodeType == XmlNodeType.ProcessingInstruction) { switch (reader.LocalName) { - case "foreach": - ++nestedForeachCount; - // Output the foreach statement - fragmentBuilder.AppendFormat("", reader.Value); - break; + case "foreach": + ++nestedForeachCount; + // Output the foreach statement + fragmentBuilder.AppendFormat("", reader.Value); + break; - case "endforeach": - --nestedForeachCount; - if (0 != nestedForeachCount) - { - fragmentBuilder.Append(""); - } - break; + case "endforeach": + --nestedForeachCount; + if (0 != nestedForeachCount) + { + fragmentBuilder.Append(""); + } + break; - default: - fragmentBuilder.AppendFormat("", reader.LocalName, reader.Value); - break; + default: + fragmentBuilder.AppendFormat("", reader.LocalName, reader.Value); + break; } } else if (reader.NodeType == XmlNodeType.Element) @@ -764,7 +760,7 @@ namespace WixToolset.Core using (var fragmentStream = new MemoryStream(Encoding.UTF8.GetBytes(fragmentBuilder.ToString()))) { // process each iteration, updating the variable's value each time - foreach (string varValue in varValues) + foreach (var varValue in varValues) { using (var loopReader = XmlReader.Create(fragmentStream, FragmentXmlReaderSettings)) { @@ -801,7 +797,7 @@ namespace WixToolset.Core } // resolve other variables in the pragma argument(s) - string pragmaArgs = this.Helper.PreprocessString(this.Context, match.Groups["pragmaValue"].Value).Trim(); + var pragmaArgs = this.Helper.PreprocessString(this.Context, match.Groups["pragmaValue"].Value).Trim(); try { @@ -823,7 +819,7 @@ namespace WixToolset.Core private string GetNextToken(string originalExpression, ref string expression, out bool stringLiteral) { stringLiteral = false; - string token = String.Empty; + var token = String.Empty; expression = expression.Trim(); if (0 == expression.Length) { @@ -833,7 +829,7 @@ namespace WixToolset.Core if (expression.StartsWith("\"", StringComparison.Ordinal)) { stringLiteral = true; - int endingQuotes = expression.IndexOf('\"', 1); + var endingQuotes = expression.IndexOf('\"', 1); if (-1 == endingQuotes) { throw new WixException(ErrorMessages.UnmatchedQuotesInExpression(this.Context.CurrentSourceLineNumber, originalExpression)); @@ -848,9 +844,9 @@ namespace WixToolset.Core else if (expression.StartsWith("$(", StringComparison.Ordinal)) { // Find the ending paren of the expression - int endingParen = -1; - int openedCount = 1; - for (int i = 2; i < expression.Length; i++) + var endingParen = -1; + var openedCount = 1; + for (var i = 2; i < expression.Length; i++) { if ('(' == expression[i]) { @@ -881,14 +877,14 @@ namespace WixToolset.Core { // Cut the token off at the next equal, space, inequality operator, // or end of string, whichever comes first - int space = expression.IndexOf(" ", StringComparison.Ordinal); - int equals = expression.IndexOf("=", StringComparison.Ordinal); - int lessThan = expression.IndexOf("<", StringComparison.Ordinal); - int lessThanEquals = expression.IndexOf("<=", StringComparison.Ordinal); - int greaterThan = expression.IndexOf(">", StringComparison.Ordinal); - int greaterThanEquals = expression.IndexOf(">=", StringComparison.Ordinal); - int notEquals = expression.IndexOf("!=", StringComparison.Ordinal); - int equalsNoCase = expression.IndexOf("~=", StringComparison.Ordinal); + var space = expression.IndexOf(" ", StringComparison.Ordinal); + var equals = expression.IndexOf("=", StringComparison.Ordinal); + var lessThan = expression.IndexOf("<", StringComparison.Ordinal); + var lessThanEquals = expression.IndexOf("<=", StringComparison.Ordinal); + var greaterThan = expression.IndexOf(">", StringComparison.Ordinal); + var greaterThanEquals = expression.IndexOf(">=", StringComparison.Ordinal); + var notEquals = expression.IndexOf("!=", StringComparison.Ordinal); + var equalsNoCase = expression.IndexOf("~=", StringComparison.Ordinal); int closingIndex; if (space == -1) @@ -970,7 +966,7 @@ namespace WixToolset.Core { // By default it's a literal and will only be evaluated if it // matches the variable format - string varValue = variable; + var varValue = variable; if (variable.StartsWith("$(", StringComparison.Ordinal)) { @@ -1008,8 +1004,7 @@ namespace WixToolset.Core /// Right side value from expression. private void GetNameValuePair(string originalExpression, ref string expression, out string leftValue, out string operation, out string rightValue) { - bool stringLiteral; - leftValue = this.GetNextToken(originalExpression, ref expression, out stringLiteral); + leftValue = this.GetNextToken(originalExpression, ref expression, out var stringLiteral); // If it wasn't a string literal, evaluate it if (!stringLiteral) @@ -1060,14 +1055,10 @@ namespace WixToolset.Core private bool EvaluateAtomicExpression(string originalExpression, ref string expression) { // Quick test to see if the first token is a variable - bool startsWithVariable = expression.StartsWith("$(", StringComparison.Ordinal); - - string leftValue; - string rightValue; - string operation; - this.GetNameValuePair(originalExpression, ref expression, out leftValue, out operation, out rightValue); + var startsWithVariable = expression.StartsWith("$(", StringComparison.Ordinal); + this.GetNameValuePair(originalExpression, ref expression, out var leftValue, out var operation, out var rightValue); - bool expressionValue = false; + var expressionValue = false; // If the variables don't exist, they were evaluated to null if (null == leftValue || null == rightValue) @@ -1168,8 +1159,8 @@ namespace WixToolset.Core } // search for the end of the expression with the matching paren - int openParenIndex = 0; - int closeParenIndex = 1; + var openParenIndex = 0; + var closeParenIndex = 1; while (openParenIndex != -1 && openParenIndex < closeParenIndex) { closeParenIndex = expression.IndexOf(')', closeParenIndex); @@ -1214,17 +1205,17 @@ namespace WixToolset.Core { switch (operation) { - case PreprocessorOperation.And: - currentValue = currentValue && prevResult; - break; - case PreprocessorOperation.Or: - currentValue = currentValue || prevResult; - break; - case PreprocessorOperation.Not: - currentValue = !currentValue; - break; - default: - throw new WixException(ErrorMessages.UnexpectedPreprocessorOperator(this.Context.CurrentSourceLineNumber, operation.ToString())); + case PreprocessorOperation.And: + currentValue = currentValue && prevResult; + break; + case PreprocessorOperation.Or: + currentValue = currentValue || prevResult; + break; + case PreprocessorOperation.Not: + currentValue = !currentValue; + break; + default: + throw new WixException(ErrorMessages.UnexpectedPreprocessorOperator(this.Context.CurrentSourceLineNumber, operation.ToString())); } } @@ -1235,7 +1226,7 @@ namespace WixToolset.Core /// Boolean result of expression. private bool EvaluateExpression(string expression) { - string tmpExpression = expression; + var tmpExpression = expression; return this.EvaluateExpressionRecurse(expression, ref tmpExpression, PreprocessorOperation.And, true); } @@ -1269,7 +1260,7 @@ namespace WixToolset.Core /// Boolean to indicate if the expression is true or false private bool EvaluateExpressionRecurse(string originalExpression, ref string expression, PreprocessorOperation prevResultOperation, bool prevResult) { - bool expressionValue = false; + var expressionValue = false; expression = expression.Trim(); if (expression.Length == 0) { @@ -1279,8 +1270,7 @@ namespace WixToolset.Core // If the expression starts with parenthesis, evaluate it if (expression.IndexOf('(') == 0) { - int endSubExpressionIndex; - string subExpression = this.GetParenthesisExpression(originalExpression, expression, out endSubExpressionIndex); + var subExpression = this.GetParenthesisExpression(originalExpression, expression, out var endSubExpressionIndex); expressionValue = this.EvaluateExpressionRecurse(originalExpression, ref subExpression, PreprocessorOperation.And, true); // Now get the rest of the expression that hasn't been evaluated @@ -1337,10 +1327,10 @@ namespace WixToolset.Core /// This is the artificial offset of the line numbers from the reader. Used for the foreach processing. private void UpdateCurrentLineNumber(XmlReader reader, int offset) { - IXmlLineInfo lineInfoReader = reader as IXmlLineInfo; + var lineInfoReader = reader as IXmlLineInfo; if (null != lineInfoReader) { - int newLine = lineInfoReader.LineNumber + offset; + var newLine = lineInfoReader.LineNumber + offset; if (this.Context.CurrentSourceLineNumber.LineNumber != newLine) { @@ -1435,19 +1425,6 @@ namespace WixToolset.Core return finalIncludePath; } - private IPreprocessContext CreateContext() - { - var context = this.ServiceProvider.GetService(); - context.Extensions = this.ServiceProvider.GetService().Create(); - context.CurrentSourceLineNumber = new SourceLineNumber(this.SourcePath); - context.Platform = this.Platform; - context.IncludeSearchPaths = this.IncludeSearchPaths?.ToList() ?? new List(); - context.SourceFile = this.SourcePath; - context.Variables = new Dictionary(this.Variables); - - return context; - } - private void PreProcess() { foreach (var extension in this.Context.Extensions) diff --git a/src/WixToolset.Core/Resolver.cs b/src/WixToolset.Core/Resolver.cs index 12cb375b..98101f16 100644 --- a/src/WixToolset.Core/Resolver.cs +++ b/src/WixToolset.Core/Resolver.cs @@ -15,7 +15,7 @@ namespace WixToolset.Core /// /// Resolver for the WiX toolset. /// - internal class Resolver + internal class Resolver : IResolver { internal Resolver(IServiceProvider serviceProvider) { @@ -38,21 +38,10 @@ namespace WixToolset.Core public IEnumerable FilterCultures { get; set; } - public ResolveResult Execute() + public ResolveResult Resolve(IResolveContext context) { - var extensionManager = this.ServiceProvider.GetService(); - - var context = this.ServiceProvider.GetService(); - context.BindPaths = this.BindPaths; - context.Extensions = extensionManager.Create(); - context.ExtensionData = extensionManager.Create(); - context.FilterCultures = this.FilterCultures; - context.IntermediateFolder = this.IntermediateFolder; - context.IntermediateRepresentation = this.IntermediateRepresentation; - context.Localizations = this.Localizations; - context.VariableResolver = new WixVariableResolver(this.Messaging); - - foreach (IResolverExtension extension in context.Extensions) + + foreach (var extension in context.Extensions) { extension.PreResolve(context); } @@ -64,11 +53,11 @@ namespace WixToolset.Core this.LocalizeUI(context); - resolveResult = this.Resolve(context); + resolveResult = this.DoResolve(context); } finally { - foreach (IResolverExtension extension in context.Extensions) + foreach (var extension in context.Extensions) { extension.PostResolve(resolveResult); } @@ -77,7 +66,7 @@ namespace WixToolset.Core return resolveResult; } - private ResolveResult Resolve(IResolveContext context) + private ResolveResult DoResolve(IResolveContext context) { var buildingPatch = context.IntermediateRepresentation.Sections.Any(s => s.Type == SectionType.Patch); diff --git a/src/WixToolset.Core/WixToolsetServiceProvider.cs b/src/WixToolset.Core/WixToolsetServiceProvider.cs index f4a9f78d..83b9356d 100644 --- a/src/WixToolset.Core/WixToolsetServiceProvider.cs +++ b/src/WixToolset.Core/WixToolsetServiceProvider.cs @@ -32,12 +32,23 @@ namespace WixToolset.Core this.AddService((provider, singletons) => new CommandLineParser(provider)); this.AddService((provider, singletons) => new PreprocessContext(provider)); this.AddService((provider, singletons) => new CompileContext(provider)); + this.AddService((provider, singletons) => new LibraryContext(provider)); this.AddService((provider, singletons) => new LinkContext(provider)); this.AddService((provider, singletons) => new ResolveContext(provider)); this.AddService((provider, singletons) => new BindContext(provider)); + this.AddService((provider, singletons) => new DecompileContext(provider)); this.AddService((provider, singletons) => new LayoutContext(provider)); this.AddService((provider, singletons) => new InscribeContext(provider)); + this.AddService((provider, singletons) => new Binder(provider)); + this.AddService((provider, singletons) => new Compiler(provider)); + this.AddService((provider, singletons) => new Decompiler(provider)); + this.AddService((provider, singletons) => new LayoutCreator(provider)); + this.AddService((provider, singletons) => new Preprocessor(provider)); + this.AddService((provider, singletons) => new Librarian(provider)); + this.AddService((provider, singletons) => new Linker(provider)); + this.AddService((provider, singletons) => new Resolver(provider)); + // Internal implementations. this.AddService((provider, singletons) => new Localizer(provider)); } -- cgit v1.2.3-55-g6feb