public void ResolveEnvironmentVariables(Platform platform, params VariableAssignment[] variables)
{
if (variables == null)
{
throw new ArgumentNullException(nameof(variables));
}
var resolver = PlatformRegistry.Query <IPlatformDescriptor>(platform)?.GetPlatformEnvironmentResolver(variables);
if (resolver != null)
{
Flush();
string content = ToString();
string cleanContent = resolver.Resolve(content);
_stream.SetLength(0);
// Logically the writer should be reusable on a modified stream after flushing it's
// buffer but the API does not guarantee that buffered writers after modifying a stream.
// So create a new string.
_writer = new StreamWriter(_stream);
_writer.Write(cleanContent);
}
}
private static bool GenerateMasterBffFile(Builder builder, ConfigurationsPerBff configurationsPerBff)
{
string masterBffFilePath = Util.GetCapitalizedPath(configurationsPerBff.BffFilePathWithExtension);
string masterBffDirectory = Path.GetDirectoryName(masterBffFilePath);
string masterBffFileName = Path.GetFileName(masterBffFilePath);
// Global configuration file is in the same directory as the master bff but filename suffix added to its filename.
string globalConfigFullPath = GetGlobalBffConfigFileName(masterBffFilePath);
string globalConfigFileName = Path.GetFileName(globalConfigFullPath);
var solutionProjects = configurationsPerBff.ResolvedProjects;
if (solutionProjects.Count == 0 && configurationsPerBff.ProjectsWereFiltered)
{
// We are running in filter mode for submit assistant and all projects were filtered out.
// We need to skip generation and delete any existing master bff file.
Util.TryDeleteFile(masterBffFilePath);
return(false);
}
// Start writing Bff
var fileGenerator = new FileGenerator();
var masterBffInfo = new MasterBffInfo();
var bffPreBuildSection = new Dictionary <string, string>();
var bffCustomPreBuildSection = new Dictionary <string, string>();
var bffMasterSection = new Dictionary <string, string>();
var masterBffCopySections = new List <string>();
var masterBffCustomSections = new UniqueList <string>(); // section that is not ordered
bool mustGenerateFastbuild = false;
var platformBffCache = new Dictionary <Platform, IPlatformBff>();
var verificationPostBuildCopies = new Dictionary <string, string>();
foreach (Solution.Configuration solutionConfiguration in configurationsPerBff)
{
foreach (var solutionProject in solutionProjects)
{
var project = solutionProject.Project;
// Export projects do not have any bff
if (project.GetType().IsDefined(typeof(Export), false))
{
continue;
}
// When the project has a source file filter, only keep it if the file list is not empty
if (project.SourceFilesFilters != null && (project.SourceFilesFiltersCount == 0 || project.SkipProjectWhenFiltersActive))
{
continue;
}
Solution.Configuration.IncludedProjectInfo includedProject = solutionConfiguration.GetProject(solutionProject.Project.GetType());
bool perfectMatch = includedProject != null && solutionProject.Configurations.Contains(includedProject.Configuration);
if (!perfectMatch)
{
continue;
}
var conf = includedProject.Configuration;
if (!conf.IsFastBuildEnabledProjectConfig())
{
continue;
}
mustGenerateFastbuild = true;
IPlatformBff platformBff = platformBffCache.GetValueOrAdd(conf.Platform, PlatformRegistry.Query <IPlatformBff>(conf.Platform));
platformBff.AddCompilerSettings(masterBffInfo.CompilerSettings, conf);
if (FastBuildSettings.WriteAllConfigsSection && includedProject.ToBuild == Solution.Configuration.IncludedProjectInfo.Build.Yes)
{
masterBffInfo.AllConfigsSections.Add(Bff.GetShortProjectName(project, conf));
}
using (fileGenerator.Declare("conf", conf))
using (fileGenerator.Declare("target", conf.Target))
using (fileGenerator.Declare("project", conf.Project))
{
var preBuildEvents = new Dictionary <string, Project.Configuration.BuildStepBase>();
if (conf.Output == Project.Configuration.OutputType.Exe || conf.ExecuteTargetCopy)
{
var copies = ProjectOptionsGenerator.ConvertPostBuildCopiesToRelative(conf, masterBffDirectory);
foreach (var copy in copies)
{
var sourceFile = copy.Key;
var sourceFileName = Path.GetFileName(sourceFile);
var destinationFolder = copy.Value;
var destinationFile = Path.Combine(destinationFolder, sourceFileName);
// use the global root for alias computation, as the project has not idea in which master bff it has been included
var destinationRelativeToGlobal = Util.GetConvertedRelativePath(masterBffDirectory, destinationFolder, conf.Project.RootPath, true, conf.Project.RootPath);
{
string key = sourceFileName + destinationRelativeToGlobal;
string currentSourceFullPath = Util.PathGetAbsolute(masterBffDirectory, sourceFile);
string previous;
if (verificationPostBuildCopies.TryGetValue(key, out previous))
{
if (previous != currentSourceFullPath)
{
builder.LogErrorLine("A post-build copy to the destination '{0}' already exist but from different sources: '{1}' and '{2}'!", Util.PathGetAbsolute(masterBffDirectory, destinationFolder), previous, currentSourceFullPath);
}
}
else
{
verificationPostBuildCopies.Add(key, currentSourceFullPath);
}
}
string fastBuildCopyAlias = UtilityMethods.GetFastBuildCopyAlias(sourceFileName, destinationRelativeToGlobal);
{
using (fileGenerator.Declare("fastBuildCopyAlias", fastBuildCopyAlias))
using (fileGenerator.Declare("fastBuildCopySource", sourceFile))
using (fileGenerator.Declare("fastBuildCopyDest", destinationFile))
{
if (!bffMasterSection.ContainsKey(fastBuildCopyAlias))
{
bffMasterSection.Add(fastBuildCopyAlias, fileGenerator.Resolver.Resolve(Bff.Template.ConfigurationFile.CopyFileSection));
}
}
}
}
foreach (var eventPair in conf.EventPreBuildExecute)
{
preBuildEvents.Add(eventPair.Key, eventPair.Value);
}
foreach (var buildEvent in conf.ResolvedEventPreBuildExe)
{
string eventKey = ProjectOptionsGenerator.MakeBuildStepName(conf, buildEvent, Vcxproj.BuildStep.PreBuild);
preBuildEvents.Add(eventKey, buildEvent);
}
WriteEvents(fileGenerator, preBuildEvents, bffPreBuildSection, masterBffDirectory);
}
var customPreBuildEvents = new Dictionary <string, Project.Configuration.BuildStepBase>();
foreach (var eventPair in conf.EventCustomPrebuildExecute)
{
customPreBuildEvents.Add(eventPair.Key, eventPair.Value);
}
foreach (var buildEvent in conf.ResolvedEventCustomPreBuildExe)
{
string eventKey = ProjectOptionsGenerator.MakeBuildStepName(conf, buildEvent, Vcxproj.BuildStep.PreBuildCustomAction);
customPreBuildEvents.Add(eventKey, buildEvent);
}
WriteEvents(fileGenerator, customPreBuildEvents, bffCustomPreBuildSection, masterBffDirectory);
if (includedProject.ToBuild == Solution.Configuration.IncludedProjectInfo.Build.Yes)
{
MergeBffIncludeTreeRecursive(conf, ref masterBffInfo.BffIncludeToDependencyIncludes);
}
}
}
}
if (!mustGenerateFastbuild)
{
throw new Error("Sharpmake-FastBuild : Trying to generate a MasterBff with none of its projects having a FastBuild configuration, or having a platform supporting it, or all of them having conf.DoNotGenerateFastBuild = true");
}
masterBffCopySections.AddRange(bffMasterSection.Values);
masterBffCopySections.AddRange(bffPreBuildSection.Values);
masterBffCustomSections.AddRange(bffCustomPreBuildSection.Values);
var result = new StringBuilder();
foreach (var projectBffFullPath in GetMasterIncludeList(masterBffInfo.BffIncludeToDependencyIncludes))
{
string projectFullPath = Path.GetDirectoryName(projectBffFullPath);
var projectPathRelativeFromMasterBff = Util.PathGetRelative(masterBffDirectory, projectFullPath, true);
string bffKeyRelative = Path.Combine(Bff.CurrentBffPathKey, Path.GetFileName(projectBffFullPath));
string include = string.Join(
Environment.NewLine,
"{",
$" {Bff.CurrentBffPathVariable} = \"{projectPathRelativeFromMasterBff}\"",
$" #include \"{bffKeyRelative}\"",
"}"
);
result.AppendLine(include);
}
string fastBuildMasterBffDependencies = result.Length == 0 ? FileGeneratorUtilities.RemoveLineTag : result.ToString();
GenerateMasterBffGlobalSettingsFile(builder, globalConfigFullPath, masterBffInfo);
using (fileGenerator.Declare("fastBuildProjectName", masterBffFileName))
using (fileGenerator.Declare("fastBuildGlobalConfigurationInclude", $"#include \"{globalConfigFileName}\""))
{
fileGenerator.Write(Bff.Template.ConfigurationFile.HeaderFile);
foreach (Platform platform in platformBffCache.Keys) // kind of cheating to use that cache instead of the masterBffInfo.CompilerSettings, but it works :)
{
using (fileGenerator.Declare("fastBuildDefine", Bff.GetPlatformSpecificDefine(platform)))
fileGenerator.Write(Bff.Template.ConfigurationFile.Define);
}
fileGenerator.Write(Bff.Template.ConfigurationFile.GlobalConfigurationInclude);
}
WriteMasterCopySection(fileGenerator, masterBffCopySections);
WriteMasterCustomSection(fileGenerator, masterBffCustomSections);
using (fileGenerator.Declare("fastBuildProjectName", masterBffFileName))
using (fileGenerator.Declare("fastBuildOrderedBffDependencies", fastBuildMasterBffDependencies))
{
fileGenerator.Write(Bff.Template.ConfigurationFile.Includes);
}
if (masterBffInfo.AllConfigsSections.Count != 0)
{
using (fileGenerator.Declare("fastBuildConfigs", UtilityMethods.FBuildFormatList(masterBffInfo.AllConfigsSections, 4)))
{
fileGenerator.Write(Bff.Template.ConfigurationFile.AllConfigsSection);
}
}
// remove all line that contain RemoveLineTag
fileGenerator.RemoveTaggedLines();
MemoryStream bffCleanMemoryStream = fileGenerator.ToMemoryStream();
// Write master .bff file
FileInfo bffFileInfo = new FileInfo(masterBffFilePath);
bool updated = builder.Context.WriteGeneratedFile(null, bffFileInfo, bffCleanMemoryStream);
foreach (var confsPerSolution in configurationsPerBff)
{
confsPerSolution.Solution.PostGenerationCallback?.Invoke(masterBffDirectory, Path.GetFileNameWithoutExtension(masterBffFileName), FastBuildSettings.FastBuildConfigFileExtension);
}
return(updated);
}
private void FillIncludeDirectoriesOptions(CompileCommandGenerationContext context)
{
// TODO: really not ideal, refactor and move the properties we need from it someplace else
var platformVcxproj = PlatformRegistry.Query <IPlatformVcxproj>(context.Configuration.Platform);
var includePaths = new OrderableStrings(platformVcxproj.GetIncludePaths(context));
var resourceIncludePaths = new OrderableStrings(platformVcxproj.GetResourceIncludePaths(context));
context.CommandLineOptions["AdditionalIncludeDirectories"] = FileGeneratorUtilities.RemoveLineTag;
context.CommandLineOptions["AdditionalResourceIncludeDirectories"] = FileGeneratorUtilities.RemoveLineTag;
context.CommandLineOptions["AdditionalUsingDirectories"] = FileGeneratorUtilities.RemoveLineTag;
var platformDescriptor = PlatformRegistry.Get <IPlatformDescriptor>(context.Configuration.Platform);
string defaultCmdLineIncludePrefix = _flags[CompilerFlags.IncludePath];
// Fill include dirs
var dirs = new List <string>();
var platformIncludePaths = platformVcxproj.GetPlatformIncludePathsWithPrefix(context);
var platformIncludePathsPrefixed = platformIncludePaths.Select(p => CmdLineConvertIncludePathsFunc(context, p.Path, p.CmdLinePrefix)).ToList();
dirs.AddRange(platformIncludePathsPrefixed);
// TODO: move back up, just below the creation of the dirs list
dirs.AddRange(includePaths.Select(p => CmdLineConvertIncludePathsFunc(context, p, defaultCmdLineIncludePrefix)));
if (dirs.Any())
{
context.CommandLineOptions["AdditionalIncludeDirectories"] = string.Join(" ", dirs);
_arguments.AddRange(dirs);
}
// Fill resource include dirs
var resourceDirs = new List <string>();
resourceDirs.AddRange(resourceIncludePaths.Select(p => CmdLineConvertIncludePathsFunc(context, p, defaultCmdLineIncludePrefix)));
if (Options.GetObject <Options.Vc.General.PlatformToolset>(context.Configuration).IsLLVMToolchain() &&
Options.GetObject <Options.Vc.LLVM.UseClangCl>(context.Configuration) == Options.Vc.LLVM.UseClangCl.Enable)
{
// with LLVM as toolchain, we are still using the default resource compiler, so we need the default include prefix
// TODO: this is not great, ideally we would need the prefix to be per "compiler", and a platform can have many
var platformIncludePathsDefaultPrefix = platformIncludePaths.Select(p => CmdLineConvertIncludePathsFunc(context, p.Path, defaultCmdLineIncludePrefix));
resourceDirs.AddRange(platformIncludePathsDefaultPrefix);
}
else
{
resourceDirs.AddRange(platformIncludePathsPrefixed);
}
if (resourceDirs.Any())
{
context.CommandLineOptions["AdditionalResourceIncludeDirectories"] = string.Join(" ", resourceDirs);
_arguments.AddRange(resourceDirs);
}
// Fill using dirs
Strings additionalUsingDirectories = Options.GetStrings <Options.Vc.Compiler.AdditionalUsingDirectories>(context.Configuration);
additionalUsingDirectories.AddRange(context.Configuration.AdditionalUsingDirectories);
additionalUsingDirectories.AddRange(platformVcxproj.GetCxUsingPath(context));
if (additionalUsingDirectories.Any())
{
var cmdAdditionalUsingDirectories = additionalUsingDirectories.Select(p => CmdLineConvertIncludePathsFunc(context, p, "/AI"));
context.CommandLineOptions["AdditionalUsingDirectories"] = string.Join(" ", cmdAdditionalUsingDirectories);
_arguments.AddRange(cmdAdditionalUsingDirectories);
}
}