From c7d69b36789b6403f5b02a975afad80f6b23b48b Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Wed, 1 Aug 2018 03:14:38 -0700 Subject: Refactor and remove code from WixToolset.BuildTask --- src/WixToolset.BuildTasks/Candle.cs | 199 --------- .../CreateItemAvoidingInference.cs | 32 +- src/WixToolset.BuildTasks/DoIt-Compile.cs | 192 -------- .../FileSearchHelperMethods.cs | 4 - src/WixToolset.BuildTasks/HeatDirectory.cs | 2 + src/WixToolset.BuildTasks/HeatFile.cs | 2 + src/WixToolset.BuildTasks/HeatProject.cs | 2 + src/WixToolset.BuildTasks/HeatTask.cs | 2 + src/WixToolset.BuildTasks/Insignia.cs | 2 + src/WixToolset.BuildTasks/Light.cs | 488 --------------------- src/WixToolset.BuildTasks/Lit.cs | 178 -------- src/WixToolset.BuildTasks/Pyro.cs | 140 ------ src/WixToolset.BuildTasks/ReplaceString.cs | 54 --- src/WixToolset.BuildTasks/TaskBase.cs | 65 --- src/WixToolset.BuildTasks/Torch.cs | 159 ------- src/WixToolset.BuildTasks/WixToolTask.cs | 403 ----------------- src/WixToolset.BuildTasks/wix.targets | 61 --- 17 files changed, 19 insertions(+), 1966 deletions(-) delete mode 100644 src/WixToolset.BuildTasks/Candle.cs delete mode 100644 src/WixToolset.BuildTasks/DoIt-Compile.cs delete mode 100644 src/WixToolset.BuildTasks/Light.cs delete mode 100644 src/WixToolset.BuildTasks/Lit.cs delete mode 100644 src/WixToolset.BuildTasks/Pyro.cs delete mode 100644 src/WixToolset.BuildTasks/ReplaceString.cs delete mode 100644 src/WixToolset.BuildTasks/TaskBase.cs delete mode 100644 src/WixToolset.BuildTasks/Torch.cs delete mode 100644 src/WixToolset.BuildTasks/WixToolTask.cs diff --git a/src/WixToolset.BuildTasks/Candle.cs b/src/WixToolset.BuildTasks/Candle.cs deleted file mode 100644 index 82b15838..00000000 --- a/src/WixToolset.BuildTasks/Candle.cs +++ /dev/null @@ -1,199 +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.BuildTasks -{ - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Globalization; - using System.IO; - using System.Text; - - using Microsoft.Build.Framework; - using Microsoft.Build.Utilities; - - /// - /// An MSBuild task to run the WiX compiler. - /// - public sealed class CandleOld : WixToolTask - { - private const string CandleToolName = "candle.exe"; - - private string[] defineConstants; - private ITaskItem[] extensions; - private string[] includeSearchPaths; - private ITaskItem outputFile; - private bool pedantic; - private string installerPlatform; - private string preprocessToFile; - private bool preprocessToStdOut; - private ITaskItem[] sourceFiles; - private string extensionDirectory; - private string[] referencePaths; - - public string[] DefineConstants - { - get { return this.defineConstants; } - set { this.defineConstants = value; } - } - - public ITaskItem[] Extensions - { - get { return this.extensions; } - set { this.extensions = value; } - } - - public string[] IncludeSearchPaths - { - get { return this.includeSearchPaths; } - set { this.includeSearchPaths = value; } - } - - public string InstallerPlatform - { - get { return this.installerPlatform; } - set { this.installerPlatform = value; } - } - - [Output] - [Required] - public ITaskItem OutputFile - { - get { return this.outputFile; } - set { this.outputFile = value; } - } - - public bool Pedantic - { - get { return this.pedantic; } - set { this.pedantic = value; } - } - - public string PreprocessToFile - { - get { return this.preprocessToFile; } - set { this.preprocessToFile = value; } - } - - public bool PreprocessToStdOut - { - get { return this.preprocessToStdOut; } - set { this.preprocessToStdOut = value; } - } - - [Required] - public ITaskItem[] SourceFiles - { - get { return this.sourceFiles; } - set { this.sourceFiles = value; } - } - - public string ExtensionDirectory - { - get { return this.extensionDirectory; } - set { this.extensionDirectory = value; } - } - - public string[] ReferencePaths - { - get { return this.referencePaths; } - set { this.referencePaths = value; } - } - - /// - /// Get the name of the executable. - /// - /// The ToolName is used with the ToolPath to get the location of candle.exe. - /// The name of the executable. - protected override string ToolName - { - get { return CandleToolName; } - } - - /// - /// Get the path to the executable. - /// - /// GetFullPathToTool is only called when the ToolPath property is not set (see the ToolName remarks above). - /// The full path to the executable or simply candle.exe if it's expected to be in the system path. - protected override string GenerateFullPathToTool() - { - // If there's not a ToolPath specified, it has to be in the system path. - if (String.IsNullOrEmpty(this.ToolPath)) - { - return CandleToolName; - } - - return Path.Combine(Path.GetFullPath(this.ToolPath), CandleToolName); - } - - /// - /// Builds a command line from options in this task. - /// - protected override void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) - { - base.BuildCommandLine(commandLineBuilder); - - commandLineBuilder.AppendIfTrue("-p", this.PreprocessToStdOut); - commandLineBuilder.AppendSwitchIfNotNull("-p", this.PreprocessToFile); - commandLineBuilder.AppendSwitchIfNotNull("-out ", this.OutputFile); - commandLineBuilder.AppendArrayIfNotNull("-d", this.DefineConstants); - commandLineBuilder.AppendArrayIfNotNull("-I", this.IncludeSearchPaths); - commandLineBuilder.AppendIfTrue("-pedantic", this.Pedantic); - commandLineBuilder.AppendSwitchIfNotNull("-arch ", this.InstallerPlatform); - commandLineBuilder.AppendExtensions(this.Extensions, this.ExtensionDirectory, this.referencePaths); - commandLineBuilder.AppendTextIfNotNull(this.AdditionalOptions); - - // Support per-source-file output by looking at the SourceFiles items to - // see if there is any "CandleOutput" metadata. If there is, we do our own - // appending, otherwise we fall back to the built-in "append file names" code. - // Note also that the wix.targets "Compile" target does *not* automagically - // fix the "@(CompileObjOutput)" list to include these new output names. - // If you really want to use this, you're going to have to clone the target - // in your own .targets file and create the output list yourself. - bool usePerSourceOutput = false; - if (this.SourceFiles != null) - { - foreach (ITaskItem item in this.SourceFiles) - { - if (!String.IsNullOrEmpty(item.GetMetadata("CandleOutput"))) - { - usePerSourceOutput = true; - break; - } - } - } - - if (usePerSourceOutput) - { - string[] newSourceNames = new string[this.SourceFiles.Length]; - for (int iSource = 0; iSource < this.SourceFiles.Length; ++iSource) - { - ITaskItem item = this.SourceFiles[iSource]; - if (null == item) - { - newSourceNames[iSource] = null; - } - else - { - string output = item.GetMetadata("CandleOutput"); - - if (!String.IsNullOrEmpty(output)) - { - newSourceNames[iSource] = String.Concat(item.ItemSpec, ";", output); - } - else - { - newSourceNames[iSource] = item.ItemSpec; - } - } - } - - commandLineBuilder.AppendFileNamesIfNotNull(newSourceNames, " "); - } - else - { - commandLineBuilder.AppendFileNamesIfNotNull(this.SourceFiles, " "); - } - } - } -} diff --git a/src/WixToolset.BuildTasks/CreateItemAvoidingInference.cs b/src/WixToolset.BuildTasks/CreateItemAvoidingInference.cs index 84816cac..3441bd85 100644 --- a/src/WixToolset.BuildTasks/CreateItemAvoidingInference.cs +++ b/src/WixToolset.BuildTasks/CreateItemAvoidingInference.cs @@ -3,11 +3,7 @@ namespace WixToolset.BuildTasks { using System; - using System.Collections; using System.Collections.Generic; - using System.Globalization; - using System.IO; - using System.Xml; using Microsoft.Build.Framework; using Microsoft.Build.Utilities; @@ -17,27 +13,17 @@ namespace WixToolset.BuildTasks /// public class CreateItemAvoidingInference : Task { - private string inputProperties; - private ITaskItem[] outputItems; - /// - /// The output items. + /// The properties to converty to items. /// - [Output] - public ITaskItem[] OuputItems - { - get { return this.outputItems; } - } + [Required] + public string InputProperties { get; set; } /// - /// The properties to converty to items. + /// The output items. /// - [Required] - public string InputProperties - { - get { return this.inputProperties; } - set { this.inputProperties = value; } - } + [Output] + public ITaskItem[] OuputItems { get; private set; } /// /// Gets a complete list of external cabs referenced by the given installer database file. @@ -45,14 +31,14 @@ namespace WixToolset.BuildTasks /// True upon completion of the task execution. public override bool Execute() { - List newItems = new List(); + var newItems = new List(); - foreach (string property in this.inputProperties.Split(new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries)) + foreach (var property in this.InputProperties.Split(new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries)) { newItems.Add(new TaskItem(property)); } - this.outputItems = newItems.ToArray(); + this.OuputItems = newItems.ToArray(); return true; } diff --git a/src/WixToolset.BuildTasks/DoIt-Compile.cs b/src/WixToolset.BuildTasks/DoIt-Compile.cs deleted file mode 100644 index f89078fe..00000000 --- a/src/WixToolset.BuildTasks/DoIt-Compile.cs +++ /dev/null @@ -1,192 +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. - -#if false -namespace WixToolset.BuildTasks -{ - using System; - using System.Collections.Generic; - using System.IO; - using Microsoft.Build.Framework; - using WixToolset.Data; - - /// - /// An MSBuild task to run the WiX compiler. - /// - public sealed class Candle : TaskBase - { - public string[] DefineConstants { get; set; } - - public ITaskItem[] Extensions { get; set; } - - public string[] IncludeSearchPaths { get; set; } - - public string InstallerPlatform { get; set; } - - [Output] - [Required] - public ITaskItem OutputFile { get; set; } - - public bool Pedantic { get; set; } - - public string PreprocessToFile { get; set; } - - public bool PreprocessToStdOut { get; set; } - - [Required] - public ITaskItem IntermediateDirectory { get; set; } - - [Required] - public ITaskItem[] SourceFiles { get; set; } - - public string ExtensionDirectory { get; set; } - - public string[] ReferencePaths { get; set; } - - protected override void ExecuteCore() - { - Messaging.Instance.InitializeAppName("WIX", "wix.exe"); - - Messaging.Instance.Display += this.DisplayMessage; - - var preprocessor = new Preprocessor(); - - var compiler = new Compiler(); - - var sourceFiles = this.GatherSourceFiles(); - - var preprocessorVariables = this.GatherPreprocessorVariables(); - - foreach (var sourceFile in sourceFiles) - { - var document = preprocessor.Process(sourceFile.SourcePath, preprocessorVariables); - - var intermediate = compiler.Compile(document); - - intermediate.Save(sourceFile.OutputPath); - } - } - - private void DisplayMessage(object sender, DisplayEventArgs e) - { - this.Log.LogMessageFromText(e.Message, MessageImportance.Normal); - } - - private IEnumerable GatherSourceFiles() - { - var files = new List(); - - foreach (var item in this.SourceFiles) - { - var sourcePath = item.ItemSpec; - var outputPath = item.GetMetadata("CandleOutput") ?? this.OutputFile?.ItemSpec; - - if (String.IsNullOrEmpty(outputPath)) - { - outputPath = Path.Combine(this.IntermediateDirectory.ItemSpec, Path.GetFileNameWithoutExtension(sourcePath) + ".wir"); - } - - files.Add(new SourceFile(sourcePath, outputPath)); - } - - return files; - } - - private IDictionary GatherPreprocessorVariables() - { - var variables = new Dictionary(); - - foreach (var pair in this.DefineConstants) - { - string[] value = pair.Split(new[] { '=' }, 2); - - if (variables.ContainsKey(value[0])) - { - //Messaging.Instance.OnMessage(WixErrors.DuplicateVariableDefinition(value[0], (1 == value.Length) ? String.Empty : value[1], this.PreprocessorVariables[value[0]])); - break; - } - - if (1 == value.Length) - { - variables.Add(value[0], String.Empty); - } - else - { - variables.Add(value[0], value[1]); - } - } - - return variables; - } - - ///// - ///// Builds a command line from options in this task. - ///// - //protected override void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) - //{ - // base.BuildCommandLine(commandLineBuilder); - - // commandLineBuilder.AppendIfTrue("-p", this.PreprocessToStdOut); - // commandLineBuilder.AppendSwitchIfNotNull("-p", this.PreprocessToFile); - // commandLineBuilder.AppendSwitchIfNotNull("-out ", this.OutputFile); - // commandLineBuilder.AppendArrayIfNotNull("-d", this.DefineConstants); - // commandLineBuilder.AppendArrayIfNotNull("-I", this.IncludeSearchPaths); - // commandLineBuilder.AppendIfTrue("-pedantic", this.Pedantic); - // commandLineBuilder.AppendSwitchIfNotNull("-arch ", this.InstallerPlatform); - // commandLineBuilder.AppendExtensions(this.Extensions, this.ExtensionDirectory, this.referencePaths); - // commandLineBuilder.AppendTextIfNotNull(this.AdditionalOptions); - - // // Support per-source-file output by looking at the SourceFiles items to - // // see if there is any "CandleOutput" metadata. If there is, we do our own - // // appending, otherwise we fall back to the built-in "append file names" code. - // // Note also that the wix.targets "Compile" target does *not* automagically - // // fix the "@(CompileObjOutput)" list to include these new output names. - // // If you really want to use this, you're going to have to clone the target - // // in your own .targets file and create the output list yourself. - // bool usePerSourceOutput = false; - // if (this.SourceFiles != null) - // { - // foreach (ITaskItem item in this.SourceFiles) - // { - // if (!String.IsNullOrEmpty(item.GetMetadata("CandleOutput"))) - // { - // usePerSourceOutput = true; - // break; - // } - // } - // } - - // if (usePerSourceOutput) - // { - // string[] newSourceNames = new string[this.SourceFiles.Length]; - // for (int iSource = 0; iSource < this.SourceFiles.Length; ++iSource) - // { - // ITaskItem item = this.SourceFiles[iSource]; - // if (null == item) - // { - // newSourceNames[iSource] = null; - // } - // else - // { - // string output = item.GetMetadata("CandleOutput"); - - // if (!String.IsNullOrEmpty(output)) - // { - // newSourceNames[iSource] = String.Concat(item.ItemSpec, ";", output); - // } - // else - // { - // newSourceNames[iSource] = item.ItemSpec; - // } - // } - // } - - // commandLineBuilder.AppendFileNamesIfNotNull(newSourceNames, " "); - // } - // else - // { - // commandLineBuilder.AppendFileNamesIfNotNull(this.SourceFiles, " "); - // } - //} - } -} -#endif diff --git a/src/WixToolset.BuildTasks/FileSearchHelperMethods.cs b/src/WixToolset.BuildTasks/FileSearchHelperMethods.cs index 6cc804eb..397c9d7c 100644 --- a/src/WixToolset.BuildTasks/FileSearchHelperMethods.cs +++ b/src/WixToolset.BuildTasks/FileSearchHelperMethods.cs @@ -3,11 +3,7 @@ namespace WixToolset.BuildTasks { using System; - using System.Collections.Generic; - using System.Diagnostics.CodeAnalysis; using System.IO; - using System.Text; - using Microsoft.Build.Framework; /// /// Contains helper methods on searching for files diff --git a/src/WixToolset.BuildTasks/HeatDirectory.cs b/src/WixToolset.BuildTasks/HeatDirectory.cs index 1d5f104a..112418e7 100644 --- a/src/WixToolset.BuildTasks/HeatDirectory.cs +++ b/src/WixToolset.BuildTasks/HeatDirectory.cs @@ -4,6 +4,7 @@ namespace WixToolset.BuildTasks { using Microsoft.Build.Framework; +#if false public sealed class HeatDirectory : HeatTask { private string directory; @@ -100,4 +101,5 @@ namespace WixToolset.BuildTasks return commandLineBuilder.ToString(); } } +#endif } diff --git a/src/WixToolset.BuildTasks/HeatFile.cs b/src/WixToolset.BuildTasks/HeatFile.cs index 69e11b88..e21d61f5 100644 --- a/src/WixToolset.BuildTasks/HeatFile.cs +++ b/src/WixToolset.BuildTasks/HeatFile.cs @@ -4,6 +4,7 @@ namespace WixToolset.BuildTasks { using Microsoft.Build.Framework; +#if false public sealed class HeatFile : HeatTask { private string file; @@ -92,4 +93,5 @@ namespace WixToolset.BuildTasks return commandLineBuilder.ToString(); } } +#endif } diff --git a/src/WixToolset.BuildTasks/HeatProject.cs b/src/WixToolset.BuildTasks/HeatProject.cs index 8620ffa3..c8f56688 100644 --- a/src/WixToolset.BuildTasks/HeatProject.cs +++ b/src/WixToolset.BuildTasks/HeatProject.cs @@ -4,6 +4,7 @@ namespace WixToolset.BuildTasks { using Microsoft.Build.Framework; +#if false public sealed class HeatProject : HeatTask { private string configuration; @@ -105,4 +106,5 @@ namespace WixToolset.BuildTasks return commandLineBuilder.ToString(); } } +#endif } diff --git a/src/WixToolset.BuildTasks/HeatTask.cs b/src/WixToolset.BuildTasks/HeatTask.cs index bf0a2ad3..8b12c48c 100644 --- a/src/WixToolset.BuildTasks/HeatTask.cs +++ b/src/WixToolset.BuildTasks/HeatTask.cs @@ -11,6 +11,7 @@ namespace WixToolset.BuildTasks using Microsoft.Build.Framework; using Microsoft.Build.Utilities; +#if false /// /// A base MSBuild task to run the WiX harvester. /// Specific harvester tasks should extend this class. @@ -118,4 +119,5 @@ namespace WixToolset.BuildTasks commandLineBuilder.AppendSwitchIfNotNull("-out ", this.OutputFile); } } +#endif } diff --git a/src/WixToolset.BuildTasks/Insignia.cs b/src/WixToolset.BuildTasks/Insignia.cs index ba30963a..d89770db 100644 --- a/src/WixToolset.BuildTasks/Insignia.cs +++ b/src/WixToolset.BuildTasks/Insignia.cs @@ -11,6 +11,7 @@ namespace WixToolset.BuildTasks using Microsoft.Build.Framework; using Microsoft.Build.Utilities; +#if false /// /// An MSBuild task to run the WiX transform generator. /// @@ -115,4 +116,5 @@ namespace WixToolset.BuildTasks return returnCode; } } +#endif } diff --git a/src/WixToolset.BuildTasks/Light.cs b/src/WixToolset.BuildTasks/Light.cs deleted file mode 100644 index b7d0b4f7..00000000 --- a/src/WixToolset.BuildTasks/Light.cs +++ /dev/null @@ -1,488 +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.BuildTasks -{ - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Diagnostics.CodeAnalysis; - using System.Globalization; - using System.IO; - using System.Text; - - using Microsoft.Build.Framework; - using Microsoft.Build.Utilities; - - /// - /// An MSBuild task to run the WiX linker. - /// - public sealed class Light : WixToolTask - { - private const string LightToolName = "Light.exe"; - - private string additionalCub; - private bool allowIdenticalRows; - private bool allowUnresolvedReferences; - private string[] baseInputPaths; - private ITaskItem[] bindInputPaths; - private bool backwardsCompatibleGuidGeneration; - private bool bindFiles; - private ITaskItem builtOutputsFile; - private string cabinetCachePath; - private int cabinetCreationThreadCount = WixCommandLineBuilder.Unspecified; - private ITaskItem contentsFile; - private string cultures; - private string customBinder; - private string defaultCompressionLevel; - private ITaskItem[] extensions; - private string[] ices; - private bool leaveTemporaryFiles; - private ITaskItem[] localizationFiles; - private ITaskItem[] objectFiles; - private bool outputAsXml; - private ITaskItem outputsFile; - private ITaskItem outputFile; - private ITaskItem pdbOutputFile; - private ITaskItem wixProjectFile; - private bool pedantic; - private bool reuseCabinetCache; - private bool suppressAclReset; - private bool suppressAssemblies; - private bool suppressDefaultAdminSequenceActions; - private bool suppressDefaultAdvSequenceActions; - private bool suppressDefaultUISequenceActions; - private bool dropUnrealTables; - private bool exactAssemblyVersions; - private bool suppressFileHashAndInfo; - private bool suppressFiles; - private bool suppressIntermediateFileVersionMatching; - private string[] suppressIces; - private bool suppressLayout; - private bool suppressLocalization; - private bool suppressMsiAssemblyTableProcessing; - private bool suppressPdbOutput; - private bool suppressSchemaValidation; - private bool suppressValidation; - private bool suppressTagSectionIdAttributeOnTuples; - private ITaskItem unreferencedSymbolsFile; - private string[] wixVariables; - private string extensionDirectory; - private string[] referencePaths; - - /// - /// Creates a new light task. - /// - /// - /// Defaults to running the task as a separate process, instead of in-proc - /// which is the default for WixToolTasks. This allows the Win32 manifest file - /// embedded in light.exe to enable reg-free COM interop with mergemod.dll. - /// - public Light() - { - } - - public string AdditionalCub - { - get { return this.additionalCub; } - set { this.additionalCub = value; } - } - - public bool AllowIdenticalRows - { - get { return this.allowIdenticalRows; } - set { this.allowIdenticalRows = value; } - } - - public bool AllowUnresolvedReferences - { - get { return this.allowUnresolvedReferences; } - set { this.allowUnresolvedReferences = value; } - } - - // TODO: remove this property entirely in v4.0 - [Obsolete("Use BindInputPaths instead of BaseInputPaths.")] - public string[] BaseInputPaths - { - get { return this.baseInputPaths; } - set { this.baseInputPaths = value; } - } - - public ITaskItem[] BindInputPaths - { - get { return this.bindInputPaths; } - set { this.bindInputPaths = value; } - } - - public bool BackwardsCompatibleGuidGeneration - { - get { return this.backwardsCompatibleGuidGeneration; } - set { this.backwardsCompatibleGuidGeneration = value; } - } - - public bool BindFiles - { - get { return this.bindFiles; } - set { this.bindFiles = value; } - } - - public string CabinetCachePath - { - get { return this.cabinetCachePath; } - set { this.cabinetCachePath = value; } - } - - public int CabinetCreationThreadCount - { - get { return this.cabinetCreationThreadCount; } - set { this.cabinetCreationThreadCount = value; } - } - - public ITaskItem BindBuiltOutputsFile - { - get { return this.builtOutputsFile; } - set { this.builtOutputsFile = value; } - } - - public ITaskItem BindContentsFile - { - get { return this.contentsFile; } - set { this.contentsFile = value; } - } - - public ITaskItem BindOutputsFile - { - get { return this.outputsFile; } - set { this.outputsFile = value; } - } - - public string Cultures - { - get { return this.cultures; } - set { this.cultures = value; } - } - - public string CustomBinder - { - get { return this.customBinder; } - set { this.customBinder = value; } - } - - public string DefaultCompressionLevel - { - get { return this.defaultCompressionLevel; } - set { this.defaultCompressionLevel = value; } - } - - public bool DropUnrealTables - { - get { return this.dropUnrealTables; } - set { this.dropUnrealTables = value; } - } - - public bool ExactAssemblyVersions - { - get { return this.exactAssemblyVersions; } - set { this.exactAssemblyVersions = value; } - } - - public ITaskItem[] Extensions - { - get { return this.extensions; } - set { this.extensions = value; } - } - - public string[] Ices - { - get { return this.ices; } - set { this.ices = value; } - } - - public bool LeaveTemporaryFiles - { - get { return this.leaveTemporaryFiles; } - set { this.leaveTemporaryFiles = value; } - } - - public ITaskItem[] LocalizationFiles - { - get { return this.localizationFiles; } - set { this.localizationFiles = value; } - } - - [Required] - public ITaskItem[] ObjectFiles - { - get { return this.objectFiles; } - set { this.objectFiles = value; } - } - - public bool OutputAsXml - { - get { return this.outputAsXml; } - set { this.outputAsXml = value; } - } - - [Required] - [Output] - public ITaskItem OutputFile - { - get { return this.outputFile; } - set { this.outputFile = value; } - } - - [Output] - public ITaskItem PdbOutputFile - { - get { return this.pdbOutputFile; } - set { this.pdbOutputFile = value; } - } - - public bool Pedantic - { - get { return this.pedantic; } - set { this.pedantic = value; } - } - - public bool ReuseCabinetCache - { - get { return this.reuseCabinetCache; } - set { this.reuseCabinetCache = value; } - } - - public bool SuppressAclReset - { - get { return this.suppressAclReset; } - set { this.suppressAclReset = value; } - } - - public bool SuppressAssemblies - { - get { return this.suppressAssemblies; } - set { this.suppressAssemblies = value; } - } - - public bool SuppressDefaultAdminSequenceActions - { - get { return this.suppressDefaultAdminSequenceActions; } - set { this.suppressDefaultAdminSequenceActions = value; } - } - - public bool SuppressDefaultAdvSequenceActions - { - get { return this.suppressDefaultAdvSequenceActions; } - set { this.suppressDefaultAdvSequenceActions = value; } - } - - public bool SuppressDefaultUISequenceActions - { - get { return this.suppressDefaultUISequenceActions; } - set { this.suppressDefaultUISequenceActions = value; } - } - - public bool SuppressFileHashAndInfo - { - get { return this.suppressFileHashAndInfo; } - set { this.suppressFileHashAndInfo = value; } - } - - public bool SuppressFiles - { - get { return this.suppressFiles; } - set { this.suppressFiles = value; } - } - - public bool SuppressIntermediateFileVersionMatching - { - get { return this.suppressIntermediateFileVersionMatching; } - set { this.suppressIntermediateFileVersionMatching = value; } - } - - public string[] SuppressIces - { - get { return this.suppressIces; } - set { this.suppressIces = value; } - } - - public bool SuppressLayout - { - get { return this.suppressLayout; } - set { this.suppressLayout = value; } - } - - public bool SuppressLocalization - { - get { return this.suppressLocalization; } - set { this.suppressLocalization = value; } - } - - [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly")] - public bool SuppressMsiAssemblyTableProcessing - { - get { return this.suppressMsiAssemblyTableProcessing; } - set { this.suppressMsiAssemblyTableProcessing = value; } - } - - public bool SuppressPdbOutput - { - get { return this.suppressPdbOutput; } - set { this.suppressPdbOutput = value; } - } - - public bool SuppressSchemaValidation - { - get { return this.suppressSchemaValidation; } - set { this.suppressSchemaValidation = value; } - } - - public bool SuppressValidation - { - get { return this.suppressValidation; } - set { this.suppressValidation = value; } - } - - public bool SuppressTagSectionIdAttributeOnTuples - { - get { return this.suppressTagSectionIdAttributeOnTuples; } - set { this.suppressTagSectionIdAttributeOnTuples = value; } - } - - [Output] - public ITaskItem UnreferencedSymbolsFile - { - get { return this.unreferencedSymbolsFile; } - set { this.unreferencedSymbolsFile = value; } - } - - [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly")] - public ITaskItem WixProjectFile - { - get { return this.wixProjectFile; } - set { this.wixProjectFile = value; } - } - - [SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly")] - public string[] WixVariables - { - get { return this.wixVariables; } - set { this.wixVariables = value; } - } - - public string ExtensionDirectory - { - get { return this.extensionDirectory; } - set { this.extensionDirectory = value; } - } - - public string[] ReferencePaths - { - get { return this.referencePaths; } - set { this.referencePaths = value; } - } - - /// - /// Get the name of the executable. - /// - /// The ToolName is used with the ToolPath to get the location of light.exe. - /// The name of the executable. - protected override string ToolName - { - get { return LightToolName; } - } - - /// - /// Get the path to the executable. - /// - /// GetFullPathToTool is only called when the ToolPath property is not set (see the ToolName remarks above). - /// The full path to the executable or simply light.exe if it's expected to be in the system path. - protected override string GenerateFullPathToTool() - { - // If there's not a ToolPath specified, it has to be in the system path. - if (String.IsNullOrEmpty(this.ToolPath)) - { - return LightToolName; - } - - return Path.Combine(Path.GetFullPath(this.ToolPath), LightToolName); - } - - /// - /// Builds a command line from options in this task. - /// - protected override void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) - { - // Always put the output first so it is easy to find in the log. - commandLineBuilder.AppendSwitchIfNotNull("-out ", this.OutputFile); - commandLineBuilder.AppendSwitchIfNotNull("-pdbout ", this.PdbOutputFile); - - base.BuildCommandLine(commandLineBuilder); - - commandLineBuilder.AppendIfTrue("-ai", this.AllowIdenticalRows); - commandLineBuilder.AppendIfTrue("-au", this.AllowUnresolvedReferences); - commandLineBuilder.AppendArrayIfNotNull("-b ", this.baseInputPaths); - - if (null != this.BindInputPaths) - { - Queue formattedBindInputPaths = new Queue(); - foreach (ITaskItem item in this.BindInputPaths) - { - String formattedPath = string.Empty; - String bindName = item.GetMetadata("BindName"); - if (!String.IsNullOrEmpty(bindName)) - { - formattedPath = String.Concat(bindName, "=", item.GetMetadata("FullPath")); - } - else - { - formattedPath = item.GetMetadata("FullPath"); - } - formattedBindInputPaths.Enqueue(formattedPath); - } - commandLineBuilder.AppendArrayIfNotNull("-b ", formattedBindInputPaths.ToArray()); - } - - commandLineBuilder.AppendIfTrue("-bcgg", this.BackwardsCompatibleGuidGeneration); - commandLineBuilder.AppendIfTrue("-bf", this.BindFiles); - commandLineBuilder.AppendSwitchIfNotNull("-cc ", this.CabinetCachePath); - commandLineBuilder.AppendIfSpecified("-ct ", this.CabinetCreationThreadCount); - commandLineBuilder.AppendSwitchIfNotNull("-cub ", this.AdditionalCub); - commandLineBuilder.AppendSwitchIfNotNull("-cultures:", this.Cultures); - commandLineBuilder.AppendSwitchIfNotNull("-binder ", this.CustomBinder); - commandLineBuilder.AppendArrayIfNotNull("-d", this.WixVariables); - commandLineBuilder.AppendSwitchIfNotNull("-dcl:", this.DefaultCompressionLevel); - commandLineBuilder.AppendIfTrue("-dut", this.DropUnrealTables); - commandLineBuilder.AppendIfTrue("-eav", this.ExactAssemblyVersions); - commandLineBuilder.AppendExtensions(this.Extensions, this.ExtensionDirectory, this.referencePaths); - commandLineBuilder.AppendArrayIfNotNull("-ice:", this.Ices); - commandLineBuilder.AppendArrayIfNotNull("-loc ", this.LocalizationFiles); - commandLineBuilder.AppendIfTrue("-notidy", this.LeaveTemporaryFiles); - commandLineBuilder.AppendIfTrue("-pedantic", this.Pedantic); - commandLineBuilder.AppendIfTrue("-reusecab", this.ReuseCabinetCache); - commandLineBuilder.AppendIfTrue("-sa", this.SuppressAssemblies); - commandLineBuilder.AppendIfTrue("-sacl", this.SuppressAclReset); - commandLineBuilder.AppendIfTrue("-sadmin", this.SuppressDefaultAdminSequenceActions); - commandLineBuilder.AppendIfTrue("-sadv", this.SuppressDefaultAdvSequenceActions); - commandLineBuilder.AppendArrayIfNotNull("-sice:", this.SuppressIces); - commandLineBuilder.AppendIfTrue("-sma", this.SuppressMsiAssemblyTableProcessing); - commandLineBuilder.AppendIfTrue("-sf", this.SuppressFiles); - commandLineBuilder.AppendIfTrue("-sh", this.SuppressFileHashAndInfo); - commandLineBuilder.AppendIfTrue("-sl", this.SuppressLayout); - commandLineBuilder.AppendIfTrue("-sloc", this.SuppressLocalization); - commandLineBuilder.AppendIfTrue("-spdb", this.SuppressPdbOutput); - commandLineBuilder.AppendIfTrue("-ss", this.SuppressSchemaValidation); - commandLineBuilder.AppendIfTrue("-sts", this.SuppressTagSectionIdAttributeOnTuples); - commandLineBuilder.AppendIfTrue("-sui", this.SuppressDefaultUISequenceActions); - commandLineBuilder.AppendIfTrue("-sv", this.SuppressIntermediateFileVersionMatching); - commandLineBuilder.AppendIfTrue("-sval", this.SuppressValidation); - commandLineBuilder.AppendSwitchIfNotNull("-usf ", this.UnreferencedSymbolsFile); - commandLineBuilder.AppendIfTrue("-xo", this.OutputAsXml); - commandLineBuilder.AppendSwitchIfNotNull("-contentsfile ", this.BindContentsFile); - commandLineBuilder.AppendSwitchIfNotNull("-outputsfile ", this.BindOutputsFile); - commandLineBuilder.AppendSwitchIfNotNull("-builtoutputsfile ", this.BindBuiltOutputsFile); - commandLineBuilder.AppendSwitchIfNotNull("-wixprojectfile ", this.WixProjectFile); - commandLineBuilder.AppendTextIfNotNull(this.AdditionalOptions); - - List objectFilePaths = AdjustFilePaths(this.objectFiles, this.ReferencePaths); - commandLineBuilder.AppendFileNamesIfNotNull(objectFilePaths.ToArray(), " "); - } - } -} diff --git a/src/WixToolset.BuildTasks/Lit.cs b/src/WixToolset.BuildTasks/Lit.cs deleted file mode 100644 index 1df964ae..00000000 --- a/src/WixToolset.BuildTasks/Lit.cs +++ /dev/null @@ -1,178 +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.BuildTasks -{ - using System; - using System.Collections.Generic; - using System.Diagnostics; - using System.Globalization; - using System.IO; - using System.Text; - - using Microsoft.Build.Framework; - using Microsoft.Build.Utilities; - - /// - /// An MSBuild task to run the WiX lib tool. - /// - public sealed class Lit : WixToolTask - { - private const string LitToolName = "lit.exe"; - - private string[] baseInputPaths; - private ITaskItem[] bindInputPaths; - private bool bindFiles; - private ITaskItem[] extensions; - private ITaskItem[] localizationFiles; - private ITaskItem[] objectFiles; - private ITaskItem outputFile; - private bool pedantic; - private bool suppressIntermediateFileVersionMatching; - private bool suppressSchemaValidation; - private string extensionDirectory; - private string[] referencePaths; - - // TODO: remove this property entirely in v4.0 - [Obsolete("Use BindInputPaths instead of BaseInputPaths.")] - public string[] BaseInputPaths - { - get { return this.baseInputPaths; } - set { this.baseInputPaths = value; } - } - - public ITaskItem[] BindInputPaths - { - get { return this.bindInputPaths; } - set { this.bindInputPaths = value; } - } - - public bool BindFiles - { - get { return this.bindFiles; } - set { this.bindFiles = value; } - } - - public ITaskItem[] Extensions - { - get { return this.extensions; } - set { this.extensions = value; } - } - - public ITaskItem[] LocalizationFiles - { - get { return this.localizationFiles; } - set { this.localizationFiles = value; } - } - - [Required] - public ITaskItem[] ObjectFiles - { - get { return this.objectFiles; } - set { this.objectFiles = value; } - } - - [Required] - [Output] - public ITaskItem OutputFile - { - get { return this.outputFile; } - set { this.outputFile = value; } - } - - public bool Pedantic - { - get { return this.pedantic; } - set { this.pedantic = value; } - } - - public bool SuppressIntermediateFileVersionMatching - { - get { return this.suppressIntermediateFileVersionMatching; } - set { this.suppressIntermediateFileVersionMatching = value; } - } - - public bool SuppressSchemaValidation - { - get { return this.suppressSchemaValidation; } - set { this.suppressSchemaValidation = value; } - } - - public string ExtensionDirectory - { - get { return this.extensionDirectory; } - set { this.extensionDirectory = value; } - } - - public string[] ReferencePaths - { - get { return this.referencePaths; } - set { this.referencePaths = value; } - } - - /// - /// Get the name of the executable. - /// - /// The ToolName is used with the ToolPath to get the location of lit.exe - /// The name of the executable. - protected override string ToolName - { - get { return LitToolName; } - } - - /// - /// Get the path to the executable. - /// - /// GetFullPathToTool is only called when the ToolPath property is not set (see the ToolName remarks above). - /// The full path to the executable or simply lit.exe if it's expected to be in the system path. - protected override string GenerateFullPathToTool() - { - // If there's not a ToolPath specified, it has to be in the system path. - if (String.IsNullOrEmpty(this.ToolPath)) - { - return LitToolName; - } - - return Path.Combine(Path.GetFullPath(this.ToolPath), LitToolName); - } - - /// - /// Builds a command line from options in this task. - /// - protected override void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) - { - base.BuildCommandLine(commandLineBuilder); - - commandLineBuilder.AppendSwitchIfNotNull("-out ", this.OutputFile); - commandLineBuilder.AppendArrayIfNotNull("-b ", this.baseInputPaths); - if (null != this.BindInputPaths) - { - Queue formattedBindInputPaths = new Queue(); - foreach (ITaskItem item in this.BindInputPaths) - { - String formattedPath = string.Empty; - String bindName = item.GetMetadata("BindName"); - if (!String.IsNullOrEmpty(item.GetMetadata("BindName"))) - { - formattedPath = String.Concat(bindName, "=", item.GetMetadata("FullPath")); - } - else - { - formattedPath = item.GetMetadata("FullPath"); - } - formattedBindInputPaths.Enqueue(formattedPath); - } - commandLineBuilder.AppendArrayIfNotNull("-b ", formattedBindInputPaths.ToArray()); - } - commandLineBuilder.AppendIfTrue("-bf", this.BindFiles); - commandLineBuilder.AppendExtensions(this.extensions, this.ExtensionDirectory, this.referencePaths); - commandLineBuilder.AppendArrayIfNotNull("-loc ", this.LocalizationFiles); - commandLineBuilder.AppendIfTrue("-pedantic", this.Pedantic); - commandLineBuilder.AppendIfTrue("-ss", this.SuppressSchemaValidation); - commandLineBuilder.AppendIfTrue("-sv", this.SuppressIntermediateFileVersionMatching); - commandLineBuilder.AppendTextIfNotNull(this.AdditionalOptions); - - List objectFilePaths = AdjustFilePaths(this.objectFiles, this.ReferencePaths); - commandLineBuilder.AppendFileNamesIfNotNull(objectFilePaths.ToArray(), " "); - } - } -} diff --git a/src/WixToolset.BuildTasks/Pyro.cs b/src/WixToolset.BuildTasks/Pyro.cs deleted file mode 100644 index f6b069da..00000000 --- a/src/WixToolset.BuildTasks/Pyro.cs +++ /dev/null @@ -1,140 +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.BuildTasks -{ - using System; - using System.Collections.Generic; - using System.IO; - using Microsoft.Build.Framework; - - /// - /// An MSBuild task to run the WiX patch builder. - /// - public sealed class Pyro : WixToolTask - { - private const string PyroToolName = "pyro.exe"; - - public bool BinaryDeltaPatch { get; set; } - public string CabinetCachePath { get; set; } - public string ExtensionDirectory { get; set; } - public ITaskItem[] Extensions { get; set; } - public bool LeaveTemporaryFiles { get; set; } - public string[] ReferencePaths { get; set; } - public bool ReuseCabinetCache { get; set; } - public bool SuppressAssemblies { get; set; } - public bool SuppressFiles { get; set; } - public bool SuppressFileHashAndInfo { get; set; } - public bool SuppressPdbOutput { get; set; } - - [Required] - public string DefaultBaselineId { get; set; } - - public ITaskItem[] BindInputPathsForTarget { get; set; } - public ITaskItem[] BindInputPathsForUpdated { get; set; } - - [Required] - public ITaskItem InputFile { get; set; } - - [Required] - [Output] - public ITaskItem OutputFile { get; set; } - - [Output] - public ITaskItem PdbOutputFile { get; set; } - - [Required] - public ITaskItem[] Transforms { get; set; } - - /// - /// Get the name of the executable. - /// - /// The ToolName is used with the ToolPath to get the location of pyro.exe. - /// The name of the executable. - protected override string ToolName - { - get { return PyroToolName; } - } - - /// - /// Get the path to the executable. - /// - /// GetFullPathToTool is only called when the ToolPath property is not set (see the ToolName remarks above). - /// The full path to the executable or simply torch.exe if it's expected to be in the system path. - protected override string GenerateFullPathToTool() - { - // If there's not a ToolPath specified, it has to be in the system path. - if (String.IsNullOrEmpty(this.ToolPath)) - { - return PyroToolName; - } - - return Path.Combine(Path.GetFullPath(this.ToolPath), PyroToolName); - } - - /// - /// Builds a command line for bind-input paths (-bt and -bu switches). - /// - private void AppendBindInputPaths(WixCommandLineBuilder commandLineBuilder, IEnumerable bindInputPaths, string switchName) - { - if (null != bindInputPaths) - { - Queue formattedBindInputPaths = new Queue(); - foreach (ITaskItem item in bindInputPaths) - { - String formattedPath = string.Empty; - String bindName = item.GetMetadata("BindName"); - if (!String.IsNullOrEmpty(bindName)) - { - formattedPath = String.Concat(bindName, "=", item.GetMetadata("FullPath")); - } - else - { - formattedPath = item.GetMetadata("FullPath"); - } - formattedBindInputPaths.Enqueue(formattedPath); - } - - commandLineBuilder.AppendArrayIfNotNull(switchName, formattedBindInputPaths.ToArray()); - } - } - - /// - /// Builds a command line from options in this task. - /// - protected override void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) - { - // Always put the output first so it is easy to find in the log. - commandLineBuilder.AppendSwitchIfNotNull("-out ", this.OutputFile); - commandLineBuilder.AppendSwitchIfNotNull("-pdbout ", this.PdbOutputFile); - - base.BuildCommandLine(commandLineBuilder); - - this.AppendBindInputPaths(commandLineBuilder, this.BindInputPathsForTarget, "-bt "); - this.AppendBindInputPaths(commandLineBuilder, this.BindInputPathsForUpdated, "-bu "); - - commandLineBuilder.AppendFileNameIfNotNull(this.InputFile); - commandLineBuilder.AppendSwitchIfNotNull("-cc ", this.CabinetCachePath); - commandLineBuilder.AppendIfTrue("-delta", this.BinaryDeltaPatch); - commandLineBuilder.AppendExtensions(this.Extensions, this.ExtensionDirectory, this.ReferencePaths); - commandLineBuilder.AppendIfTrue("-notidy", this.LeaveTemporaryFiles); - commandLineBuilder.AppendIfTrue("-reusecab", this.ReuseCabinetCache); - commandLineBuilder.AppendIfTrue("-sa", this.SuppressAssemblies); - commandLineBuilder.AppendIfTrue("-sf", this.SuppressFiles); - commandLineBuilder.AppendIfTrue("-sh", this.SuppressFileHashAndInfo); - commandLineBuilder.AppendIfTrue("-spdb", this.SuppressPdbOutput); - foreach (ITaskItem transform in this.Transforms) - { - string transformPath = transform.ItemSpec; - string baselineId = transform.GetMetadata("OverrideBaselineId"); - if (String.IsNullOrEmpty(baselineId)) - { - baselineId = this.DefaultBaselineId; - } - - commandLineBuilder.AppendTextIfNotNull(String.Format("-t {0} {1}", baselineId, transformPath)); - } - - commandLineBuilder.AppendTextIfNotNull(this.AdditionalOptions); - } - } -} diff --git a/src/WixToolset.BuildTasks/ReplaceString.cs b/src/WixToolset.BuildTasks/ReplaceString.cs deleted file mode 100644 index e5041923..00000000 --- a/src/WixToolset.BuildTasks/ReplaceString.cs +++ /dev/null @@ -1,54 +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.BuildTasks -{ - using System; - using Microsoft.Build.Framework; - using Microsoft.Build.Utilities; - - /// - /// Replaces occurances of OldValues with NewValues in String. - /// - public class ReplaceString : Task - { - /// - /// Text to operate on. - /// - [Output] - [Required] - public string Text { get; set; } - - /// - /// List of old values to replace. - /// - [Required] - public string OldValue { get; set; } - - /// - /// List of new values to replace old values with. If not specified, occurances of OldValue will be removed. - /// - public string NewValue { get; set; } - - /// - /// Does the string replacement. - /// - /// - public override bool Execute() - { - if (String.IsNullOrEmpty(this.Text)) - { - return true; - } - - if (String.IsNullOrEmpty(this.OldValue)) - { - Log.LogError("OldValue must be specified"); - return false; - } - - this.Text = this.Text.Replace(this.OldValue, this.NewValue); - - return true; - } - } -} diff --git a/src/WixToolset.BuildTasks/TaskBase.cs b/src/WixToolset.BuildTasks/TaskBase.cs deleted file mode 100644 index 3d58fc06..00000000 --- a/src/WixToolset.BuildTasks/TaskBase.cs +++ /dev/null @@ -1,65 +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.BuildTasks -{ - using Microsoft.Build.Utilities; - - public abstract class TaskBase : Task - { - public string ToolPath { get; set; } - - public string AdditionalOptions { get; set; } - - public bool RunAsSeparateProcess { get; set; } - - /// - /// Gets or sets whether all warnings should be suppressed. - /// - public bool SuppressAllWarnings { get; set; } - - /// - /// Gets or sets a list of specific warnings to be suppressed. - /// - public string[] SuppressSpecificWarnings { get; set; } - - /// - /// Gets or sets whether all warnings should be treated as errors. - /// - public bool TreatWarningsAsErrors { get; set; } - - /// - /// Gets or sets a list of specific warnings to treat as errors. - /// - public string[] TreatSpecificWarningsAsErrors { get; set; } - - /// - /// Gets or sets whether to display verbose output. - /// - public bool VerboseOutput { get; set; } - - /// - /// Gets or sets whether to display the logo. - /// - public bool NoLogo { get; set; } - - public override bool Execute() - { - try - { - this.ExecuteCore(); - } - catch (BuildException e) - { - this.Log.LogErrorFromException(e); - } - catch (Data.WixException e) - { - this.Log.LogErrorFromException(e); - } - - return !this.Log.HasLoggedErrors; - } - - protected abstract void ExecuteCore(); - } -} diff --git a/src/WixToolset.BuildTasks/Torch.cs b/src/WixToolset.BuildTasks/Torch.cs deleted file mode 100644 index e18ed315..00000000 --- a/src/WixToolset.BuildTasks/Torch.cs +++ /dev/null @@ -1,159 +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.BuildTasks -{ - using System; - using System.Diagnostics; - using System.Globalization; - using System.IO; - using System.Text; - - using Microsoft.Build.Framework; - using Microsoft.Build.Utilities; - - /// - /// An MSBuild task to run the WiX transform generator. - /// - public sealed class Torch : WixToolTask - { - private const string TorchToolName = "Torch.exe"; - - private bool adminImage; - private ITaskItem baselineFile; - private string binaryExtractionPath; - private bool inputIsXml; - private bool leaveTemporaryFiles; - private bool outputAsXml; - private ITaskItem outputFile; - private bool preserveUnmodifiedContent; - private string suppressTransformErrorFlags; - private string transformValidationFlags; - private string transformValidationType; - private ITaskItem updateFile; - - public bool AdminImage - { - get { return this.adminImage; } - set { this.adminImage = value; } - } - - - [Required] - public ITaskItem BaselineFile - { - get { return this.baselineFile; } - set { this.baselineFile = value; } - } - - public string BinaryExtractionPath - { - get { return this.binaryExtractionPath; } - set { this.binaryExtractionPath = value; } - } - - public bool LeaveTemporaryFiles - { - get { return this.leaveTemporaryFiles; } - set { this.leaveTemporaryFiles = value; } - } - - public bool InputIsXml - { - get { return this.inputIsXml; } - set { this.inputIsXml = value; } - } - - public bool OutputAsXml - { - get { return this.outputAsXml; } - set { this.outputAsXml = value; } - } - - public bool PreserveUnmodifiedContent - { - get { return this.preserveUnmodifiedContent; } - set { this.preserveUnmodifiedContent = value; } - } - - [Required] - [Output] - public ITaskItem OutputFile - { - get { return this.outputFile; } - set { this.outputFile = value; } - } - - public string SuppressTransformErrorFlags - { - get { return this.suppressTransformErrorFlags; } - set { this.suppressTransformErrorFlags = value; } - } - - public string TransformValidationType - { - get { return this.transformValidationType; } - set { this.transformValidationType = value; } - } - - public string TransformValidationFlags - { - get { return this.transformValidationFlags; } - set { this.transformValidationFlags = value; } - } - - [Required] - public ITaskItem UpdateFile - { - get { return this.updateFile; } - set { this.updateFile = value; } - } - - /// - /// Get the name of the executable. - /// - /// The ToolName is used with the ToolPath to get the location of torch.exe. - /// The name of the executable. - protected override string ToolName - { - get { return TorchToolName; } - } - - /// - /// Get the path to the executable. - /// - /// GetFullPathToTool is only called when the ToolPath property is not set (see the ToolName remarks above). - /// The full path to the executable or simply torch.exe if it's expected to be in the system path. - protected override string GenerateFullPathToTool() - { - // If there's not a ToolPath specified, it has to be in the system path. - if (String.IsNullOrEmpty(this.ToolPath)) - { - return TorchToolName; - } - - return Path.Combine(Path.GetFullPath(this.ToolPath), TorchToolName); - } - - /// - /// Builds a command line from options in this task. - /// - protected override void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) - { - base.BuildCommandLine(commandLineBuilder); - - commandLineBuilder.AppendIfTrue("-notidy", this.LeaveTemporaryFiles); - commandLineBuilder.AppendIfTrue("-xo", this.OutputAsXml); - commandLineBuilder.AppendIfTrue("-xi", this.InputIsXml); - commandLineBuilder.AppendIfTrue("-p", this.PreserveUnmodifiedContent); - commandLineBuilder.AppendTextIfNotNull(this.AdditionalOptions); - commandLineBuilder.AppendFileNameIfNotNull(this.BaselineFile); - commandLineBuilder.AppendFileNameIfNotNull(this.UpdateFile); - commandLineBuilder.AppendSwitchIfNotNull("-out ", this.OutputFile); - commandLineBuilder.AppendIfTrue("-a", this.adminImage); - commandLineBuilder.AppendSwitchIfNotNull("-x ", this.BinaryExtractionPath); - commandLineBuilder.AppendSwitchIfNotNull("-serr ", this.SuppressTransformErrorFlags); - commandLineBuilder.AppendSwitchIfNotNull("-t ", this.TransformValidationType); - commandLineBuilder.AppendSwitchIfNotNull("-val ", this.TransformValidationFlags); - } - } -} diff --git a/src/WixToolset.BuildTasks/WixToolTask.cs b/src/WixToolset.BuildTasks/WixToolTask.cs deleted file mode 100644 index 60305e00..00000000 --- a/src/WixToolset.BuildTasks/WixToolTask.cs +++ /dev/null @@ -1,403 +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.BuildTasks -{ - using System; - using System.Collections.Generic; - using System.Diagnostics.CodeAnalysis; - using System.Globalization; - using System.IO; - using System.Reflection; - using System.Text; - using System.Threading; - - using Microsoft.Build.Framework; - using Microsoft.Build.Utilities; - using WixToolset.Core.CommandLine; - - /// - /// Base class for WiX tool tasks; executes tools in-process - /// so that repeated invocations are much faster. - /// - public abstract class WixToolTask : ToolTask, IDisposable - { - private string additionalOptions; - private bool disposed; - private bool noLogo; - private bool runAsSeparateProcess; - private bool suppressAllWarnings; - private string[] suppressSpecificWarnings; - private string[] treatSpecificWarningsAsErrors; - private bool treatWarningsAsErrors; - private bool verboseOutput; - private Queue messageQueue; - private ManualResetEvent messagesAvailable; - private ManualResetEvent toolExited; - private int exitCode; - - /// - /// Gets or sets additional options that are appended the the tool command-line. - /// - /// - /// This allows the task to support extended options in the tool which are not - /// explicitly implemented as properties on the task. - /// - public string AdditionalOptions - { - get { return this.additionalOptions; } - set { this.additionalOptions = value; } - } - - /// - /// Gets or sets a flag indicating whether the task should be run as separate - /// process instead of in-proc with MSBuild which is the default. - /// - public bool RunAsSeparateProcess - { - get { return this.runAsSeparateProcess; } - set { this.runAsSeparateProcess = value; } - } - -#region Common Options - /// - /// Gets or sets whether all warnings should be suppressed. - /// - public bool SuppressAllWarnings - { - get { return this.suppressAllWarnings; } - set { this.suppressAllWarnings = value; } - } - - /// - /// Gets or sets a list of specific warnings to be suppressed. - /// - public string[] SuppressSpecificWarnings - { - get { return this.suppressSpecificWarnings; } - set { this.suppressSpecificWarnings = value; } - } - - /// - /// Gets or sets whether all warnings should be treated as errors. - /// - public bool TreatWarningsAsErrors - { - get { return this.treatWarningsAsErrors; } - set { this.treatWarningsAsErrors = value; } - } - - /// - /// Gets or sets a list of specific warnings to treat as errors. - /// - public string[] TreatSpecificWarningsAsErrors - { - get { return this.treatSpecificWarningsAsErrors; } - set { this.treatSpecificWarningsAsErrors = value; } - } - - /// - /// Gets or sets whether to display verbose output. - /// - public bool VerboseOutput - { - get { return this.verboseOutput; } - set { this.verboseOutput = value; } - } - - /// - /// Gets or sets whether to display the logo. - /// - public bool NoLogo - { - get { return this.noLogo; } - set { this.noLogo = value; } - } -#endregion - - /// - /// Cleans up the ManualResetEvent members - /// - public void Dispose() - { - if (!this.disposed) - { - this.Dispose(true); - GC.SuppressFinalize(this); - disposed = true; - } - } - - /// - /// Cleans up the ManualResetEvent members - /// - protected virtual void Dispose(bool disposing) - { - if (disposing) - { - messagesAvailable.Close(); - toolExited.Close(); - } - } - - /// - /// Generate the command line arguments to write to the response file from the properties. - /// - /// Command line string. - protected override string GenerateResponseFileCommands() - { - WixCommandLineBuilder commandLineBuilder = new WixCommandLineBuilder(); - this.BuildCommandLine(commandLineBuilder); - return commandLineBuilder.ToString(); - } - - /// - /// Builds a command line from options in this and derivative tasks. - /// - /// - /// Derivative classes should call BuildCommandLine() on the base class to ensure that common command line options are added to the command. - /// - protected virtual void BuildCommandLine(WixCommandLineBuilder commandLineBuilder) - { - commandLineBuilder.AppendIfTrue("-nologo", this.NoLogo); - commandLineBuilder.AppendArrayIfNotNull("-sw", this.SuppressSpecificWarnings); - commandLineBuilder.AppendIfTrue("-sw", this.SuppressAllWarnings); - commandLineBuilder.AppendIfTrue("-v", this.VerboseOutput); - commandLineBuilder.AppendArrayIfNotNull("-wx", this.TreatSpecificWarningsAsErrors); - commandLineBuilder.AppendIfTrue("-wx", this.TreatWarningsAsErrors); - } - - /// - /// Executes a tool in-process by loading the tool assembly and invoking its entrypoint. - /// - /// Path to the tool to be executed; must be a managed executable. - /// Commands to be written to a response file. - /// Commands to be passed directly on the command-line. - /// The tool exit code. - protected override int ExecuteTool(string pathToTool, string responseFileCommands, string commandLineCommands) - { - if (this.RunAsSeparateProcess) - { - return base.ExecuteTool(pathToTool, responseFileCommands, commandLineCommands); - } - - this.messageQueue = new Queue(); - this.messagesAvailable = new ManualResetEvent(false); - this.toolExited = new ManualResetEvent(false); - - WixToolTaskLogger logger = new WixToolTaskLogger(this.messageQueue, this.messagesAvailable); - TextWriter saveConsoleOut = Console.Out; - TextWriter saveConsoleError = Console.Error; - Console.SetOut(logger); - Console.SetError(logger); - - string responseFile = null; - try - { - responseFile = this.GetTemporaryResponseFile(responseFileCommands, out var responseFileSwitch); - if (!String.IsNullOrEmpty(responseFileSwitch)) - { - commandLineCommands = commandLineCommands + " " + responseFileSwitch; - } - - string[] arguments = CommandLineResponseFile.ParseArgumentsToArray(commandLineCommands); - - Thread toolThread = new Thread(new ParameterizedThreadStart(this.ExecuteToolThread)); - toolThread.Start(new object[] { pathToTool, arguments }); - - this.HandleToolMessages(); - - if (this.exitCode == 0 && this.Log.HasLoggedErrors) - { - this.exitCode = -1; - } - - return this.exitCode; - } - finally - { - if (responseFile != null) - { - File.Delete(responseFile); - } - - Console.SetOut(saveConsoleOut); - Console.SetError(saveConsoleError); - } - } - - /// - /// Called by a new thread to execute the tool in that thread. - /// - /// Tool path and arguments array. - private void ExecuteToolThread(object parameters) - { - try - { - object[] pathAndArguments = (object[])parameters; - Assembly toolAssembly = Assembly.LoadFrom((string)pathAndArguments[0]); - this.exitCode = (int)toolAssembly.EntryPoint.Invoke(null, new object[] { pathAndArguments[1] }); - } - catch (FileNotFoundException fnfe) - { - Log.LogError("Unable to load tool from path {0}. Consider setting the ToolPath parameter to $(WixToolPath).", fnfe.FileName); - this.exitCode = -1; - } - catch (Exception ex) - { - this.exitCode = -1; - this.LogEventsFromTextOutput(ex.Message, MessageImportance.High); - foreach (string stackTraceLine in ex.StackTrace.Split('\n')) - { - this.LogEventsFromTextOutput(stackTraceLine.TrimEnd(), MessageImportance.High); - } - - throw; - } - finally - { - this.toolExited.Set(); - } - } - - /// - /// Waits for messages from the tool thread and sends them to the MSBuild logger on the original thread. - /// Returns when the tool thread exits. - /// - private void HandleToolMessages() - { - WaitHandle[] waitHandles = new WaitHandle[] { this.messagesAvailable, this.toolExited }; - while (WaitHandle.WaitAny(waitHandles) == 0) - { - lock (this.messageQueue) - { - while (this.messageQueue.Count > 0) - { - this.LogEventsFromTextOutput(messageQueue.Dequeue(), MessageImportance.Normal); - } - - this.messagesAvailable.Reset(); - } - } - } - - /// - /// Creates a temporary response file for tool execution. - /// - /// Path to the response file. - /// - /// The temporary file should be deleted after the tool execution is finished. - /// - private string GetTemporaryResponseFile(string responseFileCommands, out string responseFileSwitch) - { - string responseFile = null; - responseFileSwitch = null; - - if (!String.IsNullOrEmpty(responseFileCommands)) - { - responseFile = Path.GetTempFileName(); - using (StreamWriter writer = new StreamWriter(responseFile, false, this.ResponseFileEncoding)) - { - writer.Write(responseFileCommands); - } - responseFileSwitch = this.GetResponseFileSwitch(responseFile); - } - return responseFile; - } - - /// - /// Cycles thru each task to find correct path of the file in question. - /// Looks at item spec, hintpath and then in user defined Reference Paths - /// - /// Input task array - /// SemiColon delimited directories to search - /// List of task item file paths - [SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists")] - protected static List AdjustFilePaths(ITaskItem[] tasks, string[] referencePaths) - { - List sourceFilePaths = new List(); - - if (tasks == null) - { - return sourceFilePaths; - } - - foreach (ITaskItem task in tasks) - { - string filePath = task.ItemSpec; - if (!File.Exists(filePath)) - { - filePath = task.GetMetadata("HintPath"); - if (!File.Exists(filePath)) - { - string searchPath = FileSearchHelperMethods.SearchFilePaths(referencePaths, filePath); - if (!String.IsNullOrEmpty(searchPath)) - { - filePath = searchPath; - } - } - } - sourceFilePaths.Add(filePath); - } - - return sourceFilePaths; - } - - /// - /// Used as a replacement for Console.Out to capture output from a tool - /// and redirect it to the MSBuild logging system. - /// - private class WixToolTaskLogger : TextWriter - { - private StringBuilder buffer; - private Queue messageQueue; - private ManualResetEvent messagesAvailable; - - /// - /// Creates a new logger that sends tool output to the tool task's log handler. - /// - public WixToolTaskLogger(Queue messageQueue, ManualResetEvent messagesAvailable) : base(CultureInfo.CurrentCulture) - { - this.messageQueue = messageQueue; - this.messagesAvailable = messagesAvailable; - this.buffer = new StringBuilder(); - } - - /// - /// Gets the encoding of the logger. - /// - public override Encoding Encoding - { - get { return Encoding.Unicode; } - } - - /// - /// Redirects output to a buffer; watches for newlines and sends each line to the - /// MSBuild logging system. - /// - /// Character being written. - /// All other Write() variants eventually call into this one. - public override void Write(char value) - { - lock (this.messageQueue) - { - if (value == '\n') - { - if (this.buffer.Length > 0 && this.buffer[this.buffer.Length - 1] == '\r') - { - this.buffer.Length = this.buffer.Length - 1; - } - - this.messageQueue.Enqueue(this.buffer.ToString()); - this.messagesAvailable.Set(); - - this.buffer.Length = 0; - } - else - { - this.buffer.Append(value); - } - } - } - } - } -} diff --git a/src/WixToolset.BuildTasks/wix.targets b/src/WixToolset.BuildTasks/wix.targets index 2edd44c4..ebd3fa90 100644 --- a/src/WixToolset.BuildTasks/wix.targets +++ b/src/WixToolset.BuildTasks/wix.targets @@ -103,11 +103,7 @@ --> - - - - @@ -782,63 +778,6 @@ - - - - PrepareForBuild; - ResolveReferences - - - - - - -