337 lines
12 KiB
C#
337 lines
12 KiB
C#
// Copyright (c) 2012-2024 Flax Engine. All rights reserved.
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using Flax.Build;
|
|
using Flax.Build.Platforms;
|
|
using Flax.Build.Projects.VisualStudio;
|
|
using Microsoft.Win32;
|
|
|
|
#pragma warning disable CA1416
|
|
|
|
namespace Flax.Deploy
|
|
{
|
|
/// <summary>
|
|
/// Stores information about a Visual C++ installation and compile environment.
|
|
/// </summary>
|
|
public static class VCEnvironment
|
|
{
|
|
private static string _msBuildPath;
|
|
private static string _cscPath;
|
|
|
|
/// <summary>
|
|
/// Gets the path to the MSBuild executable.
|
|
/// </summary>
|
|
public static string MSBuildPath
|
|
{
|
|
get
|
|
{
|
|
if (_msBuildPath == null)
|
|
_msBuildPath = GetMSBuildToolPath();
|
|
return _msBuildPath;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the path to the C# compiler executable.
|
|
/// </summary>
|
|
public static string CscPath
|
|
{
|
|
get
|
|
{
|
|
if (_cscPath == null)
|
|
_cscPath = GetCscPath();
|
|
return _cscPath;
|
|
}
|
|
}
|
|
|
|
private static string GetMSBuildToolPath()
|
|
{
|
|
string toolPath;
|
|
switch (Platform.BuildPlatform.Target)
|
|
{
|
|
case TargetPlatform.Linux:
|
|
case TargetPlatform.Mac:
|
|
{
|
|
// Use msbuild for .NET
|
|
toolPath = UnixPlatform.Which("dotnet");
|
|
if (toolPath != null)
|
|
{
|
|
return toolPath + " msbuild";
|
|
}
|
|
|
|
// Use msbuild from Mono
|
|
toolPath = UnixPlatform.Which("msbuild");
|
|
if (toolPath != null)
|
|
{
|
|
return toolPath;
|
|
}
|
|
|
|
break;
|
|
}
|
|
case TargetPlatform.Windows:
|
|
{
|
|
var visualStudioInstances = VisualStudioInstance.GetInstances();
|
|
foreach (var visualStudioInstance in visualStudioInstances)
|
|
{
|
|
toolPath = Path.Combine(visualStudioInstance.Path, "MSBuild\\Current\\Bin\\MSBuild.exe");
|
|
if (File.Exists(toolPath))
|
|
{
|
|
return toolPath;
|
|
}
|
|
}
|
|
|
|
if (CheckMsBuildPathFromRegistry("Microsoft\\VisualStudio\\SxS\\VS7", "15.0", "MSBuild\\15.0\\bin\\MSBuild.exe", out toolPath))
|
|
{
|
|
return toolPath;
|
|
}
|
|
|
|
toolPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86), "MSBuild", "14.0", "bin", "MSBuild.exe");
|
|
if (File.Exists(toolPath))
|
|
{
|
|
return toolPath;
|
|
}
|
|
|
|
if (CheckMsBuildPathFromRegistry("Microsoft\\MSBuild\\ToolsVersions\\14.0", "MSBuildToolsPath", "MSBuild.exe", out toolPath))
|
|
{
|
|
return toolPath;
|
|
}
|
|
|
|
if (CheckMsBuildPathFromRegistry("Microsoft\\MSBuild\\ToolsVersions\\12.0", "MSBuildToolsPath", "MSBuild.exe", out toolPath))
|
|
{
|
|
return toolPath;
|
|
}
|
|
|
|
if (CheckMsBuildPathFromRegistry("Microsoft\\MSBuild\\ToolsVersions\\4.0", "MSBuildToolsPath", "MSBuild.exe", out toolPath))
|
|
{
|
|
return toolPath;
|
|
}
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
return string.Empty;
|
|
}
|
|
|
|
private static string GetCscPath()
|
|
{
|
|
string toolPath;
|
|
switch (Platform.BuildPlatform.Target)
|
|
{
|
|
case TargetPlatform.Linux:
|
|
case TargetPlatform.Mac:
|
|
{
|
|
// Use csc from Mono
|
|
toolPath = UnixPlatform.Which("csc");
|
|
if (toolPath != null)
|
|
{
|
|
return toolPath;
|
|
}
|
|
break;
|
|
}
|
|
case TargetPlatform.Windows:
|
|
{
|
|
if (CheckMsBuildPathFromRegistry("Microsoft\\VisualStudio\\SxS\\VS7", "15.0", "MSBuild\\15.0\\bin\\csc.exe", out toolPath))
|
|
{
|
|
return toolPath;
|
|
}
|
|
|
|
toolPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86), "MSBuild", "14.0", "bin", "csc.exe");
|
|
if (File.Exists(toolPath))
|
|
{
|
|
return toolPath;
|
|
}
|
|
|
|
if (CheckMsBuildPathFromRegistry("Microsoft\\MSBuild\\ToolsVersions\\14.0", "MSBuildToolsPath", "csc.exe", out toolPath))
|
|
{
|
|
return toolPath;
|
|
}
|
|
|
|
if (CheckMsBuildPathFromRegistry("Microsoft\\MSBuild\\ToolsVersions\\12.0", "MSBuildToolsPath", "csc.exe", out toolPath))
|
|
{
|
|
return toolPath;
|
|
}
|
|
|
|
if (CheckMsBuildPathFromRegistry("Microsoft\\MSBuild\\ToolsVersions\\4.0", "MSBuildToolsPath", "csc.exe", out toolPath))
|
|
{
|
|
return toolPath;
|
|
}
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
return string.Empty;
|
|
}
|
|
|
|
private static bool CheckMsBuildPathFromRegistry(string keyRelativePath, string keyName, string msBuildRelativePath, out string outMsBuildPath)
|
|
{
|
|
string[] prefixes =
|
|
{
|
|
@"HKEY_CURRENT_USER\SOFTWARE\",
|
|
@"HKEY_LOCAL_MACHINE\SOFTWARE\",
|
|
@"HKEY_CURRENT_USER\SOFTWARE\Wow6432Node\",
|
|
@"HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\"
|
|
};
|
|
|
|
for (var i = 0; i < prefixes.Length; i++)
|
|
{
|
|
if (Registry.GetValue(prefixes[i] + keyRelativePath, keyName, null) is string value)
|
|
{
|
|
string msBuildPath = Path.Combine(value, msBuildRelativePath);
|
|
if (File.Exists(msBuildPath))
|
|
{
|
|
outMsBuildPath = msBuildPath;
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
outMsBuildPath = null;
|
|
return false;
|
|
}
|
|
|
|
internal static string Verbosity => Configuration.Verbose ? "" : "/verbosity:minimal";
|
|
|
|
/// <summary>
|
|
/// Runs msbuild.exe with the specified arguments.
|
|
/// </summary>
|
|
/// <param name="project">Path to the project to build.</param>
|
|
/// <param name="buildConfig">Configuration to build.</param>
|
|
/// <param name="buildPlatform">Platform to build.</param>
|
|
public static void BuildProject(string project, string buildConfig, string buildPlatform)
|
|
{
|
|
var msBuild = MSBuildPath;
|
|
if (string.IsNullOrEmpty(msBuild))
|
|
{
|
|
throw new Exception(string.Format("Unable to find msbuild.exe at: \"{0}\"", msBuild));
|
|
}
|
|
|
|
if (!File.Exists(project))
|
|
{
|
|
throw new Exception(string.Format("Project {0} does not exist!", project));
|
|
}
|
|
|
|
string cmdLine = string.Format("\"{0}\" /m /t:Restore,Build /p:Configuration=\"{1}\" /p:Platform=\"{2}\" {3} /nologo", project, buildConfig, buildPlatform, Verbosity);
|
|
int result = Utilities.Run(msBuild, cmdLine);
|
|
if (result != 0)
|
|
{
|
|
throw new Exception(string.Format("Unable to build project {0}. MSBuild failed. See log to learn more.", project));
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Builds a Visual Studio solution with MsBuild.
|
|
/// </summary>
|
|
/// <param name="solutionFile">Path to the solution file</param>
|
|
/// <param name="buildConfig">Configuration to build.</param>
|
|
/// <param name="buildPlatform">Platform to build.</param>
|
|
/// <param name="props">Custom build properties mapping (property=value).</param>
|
|
/// <param name="msBuild">Custom MSBuild executable path.</param>
|
|
public static void BuildSolution(string solutionFile, string buildConfig, string buildPlatform, Dictionary<string, string> props = null, string msBuild = null)
|
|
{
|
|
if (msBuild == null)
|
|
msBuild = MSBuildPath;
|
|
if (string.IsNullOrEmpty(msBuild))
|
|
{
|
|
throw new Exception(string.Format("Unable to find msbuild.exe at: \"{0}\"", msBuild));
|
|
}
|
|
|
|
if (!File.Exists(solutionFile))
|
|
{
|
|
// CMake VS2026 generator prefers .slnx solution files, just swap the extension for CMake dependencies
|
|
if (File.Exists(Path.ChangeExtension(solutionFile, "slnx")))
|
|
solutionFile = Path.ChangeExtension(solutionFile, "slnx");
|
|
else
|
|
throw new Exception(string.Format("Unable to build solution {0}. Solution file not found.", solutionFile));
|
|
}
|
|
|
|
string cmdLine = string.Format("\"{0}\" /m /t:Restore,Build /p:Configuration=\"{1}\" /p:Platform=\"{2}\" {3} /nologo", solutionFile, buildConfig, buildPlatform, Verbosity);
|
|
if (props != null)
|
|
{
|
|
foreach (var e in props)
|
|
cmdLine += string.Format(" /p:{0}={1}", e.Key, e.Value);
|
|
}
|
|
int result = Utilities.Run(msBuild, cmdLine);
|
|
if (result != 0)
|
|
{
|
|
throw new Exception(string.Format("Unable to build solution {0}. MSBuild failed. See log to learn more.", solutionFile));
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Clears the build a Visual Studio solution cache with MsBuild.
|
|
/// </summary>
|
|
/// <param name="solutionFile">Path to the solution file</param>
|
|
public static void CleanSolution(string solutionFile)
|
|
{
|
|
var msBuild = MSBuildPath;
|
|
if (string.IsNullOrEmpty(msBuild))
|
|
{
|
|
throw new Exception(string.Format("Unable to find msbuild.exe at: \"{0}\"", msBuild));
|
|
}
|
|
|
|
if (!File.Exists(solutionFile))
|
|
{
|
|
throw new Exception(string.Format("Unable to clean solution {0}. Solution file not found.", solutionFile));
|
|
}
|
|
|
|
string cmdLine = string.Format("\"{0}\" /t:Clean {1} /nologo", solutionFile, Verbosity);
|
|
Utilities.Run(msBuild, cmdLine);
|
|
}
|
|
|
|
internal static void CodeSign(string file, string certificate, string password)
|
|
{
|
|
if (!File.Exists(file))
|
|
throw new FileNotFoundException("Missing file to sign.", file);
|
|
if (string.IsNullOrEmpty(certificate))
|
|
throw new Exception("Missing certificate to sign.");
|
|
|
|
// Get path to signtool
|
|
var sdks = WindowsPlatformBase.GetSDKs();
|
|
if (sdks.Count == 0)
|
|
throw new Exception("No Windows SDK found. Cannot sign file.");
|
|
var signtool = string.Empty;
|
|
foreach (var e in sdks)
|
|
{
|
|
try
|
|
{
|
|
var sdk = e.Value;
|
|
signtool = Path.Combine(sdk, "bin", "x64", "signtool.exe");
|
|
if (File.Exists(signtool))
|
|
break;
|
|
var ver = WindowsPlatformBase.GetSDKVersion(e.Key);
|
|
signtool = Path.Combine(sdk, "bin", ver.ToString(4), "x64", "signtool.exe");
|
|
if (File.Exists(signtool))
|
|
break;
|
|
}
|
|
catch
|
|
{
|
|
// Ignore version formatting exception
|
|
}
|
|
}
|
|
|
|
// Sign code
|
|
string cmdLine;
|
|
var time = "/tr http://time.certum.pl /td sha256";
|
|
if (File.Exists(certificate))
|
|
{
|
|
// Sign with certificate from file
|
|
cmdLine = $"sign /debug /f \"{certificate}\" {time} /fd sha256 \"{file}\"";
|
|
if (!string.IsNullOrEmpty(password))
|
|
cmdLine += $" /p \"{password}\"";
|
|
}
|
|
else
|
|
{
|
|
// Sign with identity
|
|
cmdLine = $"sign /debug /n \"{certificate}\" {time} /fd sha256 /v \"{file}\"";
|
|
}
|
|
Utilities.Run(signtool, cmdLine, null, null, Utilities.RunOptions.Default | Utilities.RunOptions.ThrowExceptionOnError);
|
|
}
|
|
}
|
|
}
|
|
|
|
#pragma warning restore CA1416
|