|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
#if NETFRAMEWORK
using System;
using System.Diagnostics;
using System.IO;
using System.Text;
using Microsoft.Build.Shared;
#endif
using System.Diagnostics.CodeAnalysis;
using Microsoft.Build.Framework;
#nullable disable
namespace Microsoft.Build.Tasks
{
#if NETFRAMEWORK
/// <summary>
/// Exports a managed assembly to a windows runtime metadata.
/// </summary>
[MSBuildMultiThreadableTask]
public class WinMDExp : ToolTaskExtension, IWinMDExpTaskContract
{
#region Properties
/// <summary>
/// Set of references to pass to the winmdexp tool.
/// </summary>
[Required]
public ITaskItem[] References
{
get => (ITaskItem[])Bag[nameof(References)];
set
{
ErrorUtilities.VerifyThrowArgumentNull(value, nameof(References));
Bag[nameof(References)] = value;
}
}
/// <summary>
/// Warning codes to disable
/// </summary>
public string DisabledWarnings
{
get => (string)Bag[nameof(DisabledWarnings)];
set
{
ErrorUtilities.VerifyThrowArgumentNull(value, nameof(DisabledWarnings));
Bag[nameof(DisabledWarnings)] = value;
}
}
/// <summary>
/// Input documentation file
/// </summary>
public string InputDocumentationFile
{
get => (string)Bag[nameof(InputDocumentationFile)];
set
{
ErrorUtilities.VerifyThrowArgumentNull(value, nameof(InputDocumentationFile));
Bag[nameof(InputDocumentationFile)] = value;
}
}
/// <summary>
/// Output documentation file
/// </summary>
public string OutputDocumentationFile
{
get => (string)Bag[nameof(OutputDocumentationFile)];
set
{
ErrorUtilities.VerifyThrowArgumentNull(value, nameof(OutputDocumentationFile));
Bag[nameof(OutputDocumentationFile)] = value;
}
}
/// <summary>
/// Input PDB file
/// </summary>
public string InputPDBFile
{
get => (string)Bag[nameof(InputPDBFile)];
set
{
ErrorUtilities.VerifyThrowArgumentNull(value, nameof(InputPDBFile));
Bag[nameof(InputPDBFile)] = value;
}
}
/// <summary>
/// Output PDB file
/// </summary>
public string OutputPDBFile
{
get => (string)Bag[nameof(OutputPDBFile)];
set
{
ErrorUtilities.VerifyThrowArgumentNull(value, nameof(OutputPDBFile));
Bag[nameof(OutputPDBFile)] = value;
}
}
/// <summary>
/// WinMDModule to generate the WinMDFile for.
/// </summary>
[Required]
public string WinMDModule
{
get => (string)Bag[nameof(WinMDModule)];
set
{
ErrorUtilities.VerifyThrowArgumentNull(value, nameof(WinMDModule));
Bag[nameof(WinMDModule)] = value;
}
}
/// <summary>
/// Output windows metadata file .winmd
/// </summary>
[Output]
public string OutputWindowsMetadataFile
{
get => (string)Bag[nameof(OutputWindowsMetadataFile)];
set
{
ErrorUtilities.VerifyThrowArgumentNull(value, nameof(OutputWindowsMetadataFile));
Bag[nameof(OutputWindowsMetadataFile)] = value;
}
}
/// <summary>
/// Path to the SDK directory which contains this tool
/// </summary>
public string SdkToolsPath
{
get => (string)Bag[nameof(SdkToolsPath)];
set => Bag[nameof(SdkToolsPath)] = value;
}
/// <summary>
/// Use output stream encoding as UTF-8.
/// </summary>
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "UTF", Justification = "Not worth breaking customers because of case correction")]
public bool UTF8Output
{
get => (bool)Bag[nameof(UTF8Output)];
set => Bag[nameof(UTF8Output)] = value;
}
/// <summary>
/// Path to the SDK directory which contains this tool
/// </summary>
public bool TreatWarningsAsErrors
{
get => (bool)Bag[nameof(TreatWarningsAsErrors)];
set => Bag[nameof(TreatWarningsAsErrors)] = value;
}
/// <summary>
/// The policy used for assembly unification.
/// </summary>
public string AssemblyUnificationPolicy
{
get => (string)Bag[nameof(AssemblyUnificationPolicy)];
set
{
ErrorUtilities.VerifyThrowArgumentNull(value, nameof(AssemblyUnificationPolicy));
Bag[nameof(AssemblyUnificationPolicy)] = value;
}
}
/// <summary>
/// The name of the tool to execute.
/// </summary>
protected override string ToolName => "winmdexp.exe";
/// <summary>
/// Overridable property specifying the encoding of the captured task standard output stream
/// </summary>
protected override Encoding StandardOutputEncoding => UTF8Output ? Encoding.UTF8 : base.StandardOutputEncoding;
/// <summary>
/// Overridable property specifying the encoding of the captured task standard error stream
/// </summary>
protected override Encoding StandardErrorEncoding => UTF8Output ? Encoding.UTF8 : base.StandardErrorEncoding;
protected override bool UseNewLineSeparatorInResponseFile => true;
#endregion
#region Tool Members
protected internal override void AddResponseFileCommands(CommandLineBuilderExtension commandLine)
{
commandLine.AppendSwitchUnquotedIfNotNull("/d:", OutputDocumentationFile);
commandLine.AppendSwitchUnquotedIfNotNull("/md:", InputDocumentationFile);
commandLine.AppendSwitchUnquotedIfNotNull("/mp:", InputPDBFile);
commandLine.AppendSwitchUnquotedIfNotNull("/pdb:", OutputPDBFile);
commandLine.AppendSwitchUnquotedIfNotNull("/assemblyunificationpolicy:", AssemblyUnificationPolicy);
if (String.IsNullOrEmpty(OutputWindowsMetadataFile))
{
OutputWindowsMetadataFile = Path.ChangeExtension(WinMDModule, ".winmd");
}
commandLine.AppendSwitchUnquotedIfNotNull("/out:", OutputWindowsMetadataFile);
commandLine.AppendSwitchWithSplitting("/nowarn:", DisabledWarnings, ",", ';', ',');
commandLine.AppendWhenTrue("/warnaserror+", Bag, "TreatWarningsAsErrors");
commandLine.AppendWhenTrue("/utf8output", Bag, "UTF8Output");
if (References != null)
{
// Loop through all the references passed in. We'll be adding separate
foreach (ITaskItem reference in References)
{
commandLine.AppendSwitchUnquotedIfNotNull("/reference:", reference.ItemSpec);
}
}
// There is no public method to add unquoted text that includes a separator. Calling this method with String.Empty adds a separator
// and the unquoted text and no parameter.
commandLine.AppendSwitchUnquotedIfNotNull(WinMDModule, String.Empty);
base.AddResponseFileCommands(commandLine);
}
/// <summary>
/// The full path of the tool to execute.
/// </summary>
protected override string GenerateFullPathToTool() => SdkToolsPathUtility.GeneratePathToTool(
f => !string.IsNullOrEmpty(f)
? SdkToolsPathUtility.FileInfoExists(TaskEnvironment.GetAbsolutePath(f))
: SdkToolsPathUtility.FileInfoExists(f),
Utilities.ProcessorArchitecture.CurrentProcessArchitecture,
SdkToolsPath,
ToolExe,
Log,
true);
protected override ProcessStartInfo GetProcessStartInfo(string pathToTool, string commandLineCommands, string responseFileSwitch)
{
if (!string.IsNullOrEmpty(pathToTool) && Path.GetFileName(pathToTool).Length != pathToTool.Length)
{
pathToTool = TaskEnvironment.GetAbsolutePath(pathToTool);
}
return base.GetProcessStartInfo(pathToTool, commandLineCommands, responseFileSwitch);
}
/// <summary>
/// Validate parameters, log errors and warnings and return true if Execute should proceed.
/// </summary>
protected override bool ValidateParameters()
{
if (References == null)
{
Log.LogErrorWithCodeFromResources("WinMDExp.MustPassReferences");
return false;
}
return true;
}
/// <summary>
/// Returns true if task execution is not necessary. Executed after ValidateParameters
/// </summary>
protected override bool SkipTaskExecution()
{
if (!String.IsNullOrEmpty(OutputWindowsMetadataFile))
{
AbsolutePath outputWindowsMetadataFile = TaskEnvironment.GetAbsolutePath(OutputWindowsMetadataFile);
AbsolutePath winMDModule = TaskEnvironment.GetAbsolutePath(WinMDModule);
var outputWriteTime = NativeMethodsShared.GetLastWriteFileUtcTime(outputWindowsMetadataFile);
var winMDModuleWriteTime = NativeMethodsShared.GetLastWriteFileUtcTime(winMDModule);
// If the last write time of the input file is less than the last write time of the output file
if (outputWriteTime > winMDModuleWriteTime)
{
return true;
}
}
return false;
}
#endregion
}
#else
public sealed class WinMDExp : TaskRequiresFramework, IWinMDExpTaskContract
{
public WinMDExp()
: base(nameof(WinMDExp))
{
}
#region Properties
public ITaskItem[] References { get; set; }
public string DisabledWarnings { get; set; }
public string InputDocumentationFile { get; set; }
public string OutputDocumentationFile { get; set; }
public string InputPDBFile { get; set; }
public string OutputPDBFile { get; set; }
public string WinMDModule { get; set; }
[Output]
public string OutputWindowsMetadataFile { get; set; }
public string SdkToolsPath { get; set; }
[SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "UTF", Justification = "Not worth breaking customers because of case correction")]
public bool UTF8Output { get; set; }
public bool TreatWarningsAsErrors { get; set; }
public string AssemblyUnificationPolicy { get; set; }
#endregion
}
#endif
internal interface IWinMDExpTaskContract
{
#region Properties
ITaskItem[] References { get; set; }
string DisabledWarnings { get; set; }
string InputDocumentationFile { get; set; }
string OutputDocumentationFile { get; set; }
string InputPDBFile { get; set; }
string OutputPDBFile { get; set; }
string WinMDModule { get; set; }
string OutputWindowsMetadataFile { get; set; }
string SdkToolsPath { get; set; }
bool UTF8Output { get; set; }
bool TreatWarningsAsErrors { get; set; }
string AssemblyUnificationPolicy { get; set; }
#endregion
}
}
|