1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
// 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.BaseBuildTasks
{
using System;
using System.IO;
using System.Runtime.InteropServices;
using Microsoft.Build.Utilities;
public abstract class BaseToolsetTask : ToolTask
{
/// <summary>
/// Gets or sets additional options that are appended the the tool command-line.
/// </summary>
/// <remarks>
/// This allows the task to support extended options in the tool which are not
/// explicitly implemented as properties on the task.
/// </remarks>
public string AdditionalOptions { get; set; }
/// <summary>
/// Gets or sets whether to display the logo.
/// </summary>
public bool NoLogo { get; set; }
/// <summary>
/// Gets or sets whether all warnings should be suppressed.
/// </summary>
public bool SuppressAllWarnings { get; set; }
/// <summary>
/// Gets or sets a list of specific warnings to be suppressed.
/// </summary>
public string[] SuppressSpecificWarnings { get; set; }
/// <summary>
/// Gets or sets whether all warnings should be treated as errors.
/// </summary>
public bool TreatWarningsAsErrors { get; set; }
/// <summary>
/// Gets or sets a list of specific warnings to treat as errors.
/// </summary>
public string[] TreatSpecificWarningsAsErrors { get; set; }
/// <summary>
/// Gets or sets whether to display verbose output.
/// </summary>
public bool VerboseOutput { get; set; }
/// <summary>
/// Get the path to the executable.
/// </summary>
/// <remarks>
/// ToolTask only calls GenerateFullPathToTool when the ToolPath property is not set.
/// WiX never sets the ToolPath property, but the user can through $(WixToolDir).
/// If we return only a file name, ToolTask will search the system paths for it.
/// </remarks>
protected sealed override string GenerateFullPathToTool()
{
var defaultToolFullPath = this.GetDefaultToolFullPath();
#if NETCOREAPP
// If we're pointing at an executable use that.
if (IsSelfExecutable(defaultToolFullPath, out var finalToolFullPath))
{
return finalToolFullPath;
}
// Otherwise, use "dotnet.exe" to run an assembly dll.
return Environment.GetEnvironmentVariable("DOTNET_HOST_PATH") ?? "dotnet";
#else
return defaultToolFullPath;
#endif
}
/// <summary>
/// Builds a command line from options in this and derivative tasks.
/// </summary>
/// <remarks>
/// Derivative classes should call BuildCommandLine() on the base class to ensure that common command line options are added to the command.
/// </remarks>
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);
commandLineBuilder.AppendTextIfNotNull(this.AdditionalOptions);
}
protected sealed override string GenerateResponseFileCommands()
{
var commandLineBuilder = new WixCommandLineBuilder();
this.BuildCommandLine(commandLineBuilder);
return commandLineBuilder.ToString();
}
#if NETCOREAPP
protected override string GenerateCommandLineCommands()
{
// If the target tool path is an executable, we don't need to add anything to the command-line.
var toolFullPath = this.GetToolFullPath();
if (IsSelfExecutable(toolFullPath, out var finalToolFullPath))
{
return null;
}
else // we're using "dotnet.exe" to run the assembly so add "exec" plus path to the command-line.
{
return $"exec \"{finalToolFullPath}\"";
}
}
private static bool IsSelfExecutable(string proposedToolFullPath, out string finalToolFullPath)
{
var toolFullPathWithoutExtension = Path.Combine(Path.GetDirectoryName(proposedToolFullPath), Path.GetFileNameWithoutExtension(proposedToolFullPath));
var exeExtension = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? ".exe" : String.Empty;
var exeToolFullPath = $"{toolFullPathWithoutExtension}{exeExtension}";
if (File.Exists(exeToolFullPath))
{
finalToolFullPath = exeToolFullPath;
return true;
}
finalToolFullPath = $"{toolFullPathWithoutExtension}.dll";
return false;
}
#else
private static string GetArchitectureFolder(string baseFolder)
{
// First try to find a folder that matches this task's architecture.
var folder = RuntimeInformation.ProcessArchitecture.ToString().ToLowerInvariant();
if (Directory.Exists(Path.Combine(baseFolder, folder)))
{
return folder;
}
// Try to fallback to "x86" folder.
if (folder != "x86" && Directory.Exists(Path.Combine(baseFolder, "x86")))
{
return "x86";
}
// Return empty, even though this isn't likely to be useful.
return String.Empty;
}
#endif
private string GetDefaultToolFullPath()
{
#if NETCOREAPP
var thisTaskFolder = Path.GetDirectoryName(typeof(BaseToolsetTask).Assembly.Location);
return Path.Combine(thisTaskFolder, this.ToolExe);
#else
var thisTaskFolder = Path.GetDirectoryName(new Uri(typeof(BaseToolsetTask).Assembly.CodeBase).AbsolutePath);
var archFolder = GetArchitectureFolder(thisTaskFolder);
return Path.Combine(thisTaskFolder, archFolder, this.ToolExe);
#endif
}
private string GetToolFullPath()
{
if (String.IsNullOrEmpty(this.ToolPath))
{
return this.GetDefaultToolFullPath();
}
return Path.Combine(this.ToolPath, this.ToolExe);
}
}
}
|
