internal static void WriteCustomBuildStepAsGenericExecutable(string projectRoot, FileGenerator bffGenerator, Project.Configuration.CustomFileBuildStep buildStep, Func <Project.Configuration.CustomFileBuildStepData, bool> functor)
{
var relativeBuildStep = buildStep.MakePathRelative(bffGenerator.Resolver,
(path, commandRelative) =>
{
string relativePath = Util.SimplifyPath(Util.PathGetRelative(projectRoot, path));
if (commandRelative)
{
return(Bff.CurrentBffPathKeyCombine(relativePath));
}
else
{
return(relativePath);
}
});
using (bffGenerator.Declare("fastBuildPreBuildName", relativeBuildStep.Description))
using (bffGenerator.Declare("fastBuildPrebuildExeFile", relativeBuildStep.Executable))
using (bffGenerator.Declare("fastBuildPreBuildInputFiles", FBuildFormatSingleListItem(relativeBuildStep.KeyInput)))
using (bffGenerator.Declare("fastBuildPreBuildOutputFile", relativeBuildStep.Output))
using (bffGenerator.Declare("fastBuildPreBuildArguments", string.IsNullOrWhiteSpace(relativeBuildStep.ExecutableArguments) ? FileGeneratorUtilities.RemoveLineTag : relativeBuildStep.ExecutableArguments))
// This is normally the project directory.
using (bffGenerator.Declare("fastBuildPrebuildWorkingPath", FileGeneratorUtilities.RemoveLineTag))
using (bffGenerator.Declare("fastBuildPrebuildUseStdOutAsOutput", FileGeneratorUtilities.RemoveLineTag))
using (bffGenerator.Declare("fastBuildPrebuildAlwaysShowOutput", FileGeneratorUtilities.RemoveLineTag))
using (bffGenerator.Declare("fastBuildExecPreBuildDependencies", FileGeneratorUtilities.RemoveLineTag))
using (bffGenerator.Declare("fastBuildExecAlways", FileGeneratorUtilities.RemoveLineTag))
{
functor(relativeBuildStep);
}
}
internal static string GetNormalizedPathForBuildStep(string projectRootPath, string projectFolderPath, string path)
{
if (string.IsNullOrEmpty(path))
{
return(FileGeneratorUtilities.RemoveLineTag);
}
if (path.StartsWith(projectRootPath, StringComparison.OrdinalIgnoreCase))
{
return(Bff.CurrentBffPathKeyCombine(Util.PathGetRelative(projectFolderPath, path)));
}
// keep the full path for the source if outside of the global root
return(path);
}
public override string GetCommand(BuildType buildType, Sharpmake.Project.Configuration conf, string fastbuildArguments)
{
Project project = conf.Project;
string fastBuildShortProjectName = Bff.GetShortProjectName(project, conf);
string makePath = FastBuildSettings.FastBuildMakeCommand;
if (!Path.IsPathRooted(FastBuildSettings.FastBuildMakeCommand))
{
makePath = conf.Project.RootPath + Path.DirectorySeparatorChar + FastBuildSettings.FastBuildMakeCommand;
}
makePath = Util.SimplifyPath(makePath);
string fastBuildExecutable = Util.PathGetRelative(conf.ProjectPath, makePath, true);
string rebuildCmd = buildType == BuildType.Rebuild ? " -clean" : "";
// $(ProjectDir) has a trailing slash
return($@"""$(ProjectDir){fastBuildExecutable}""{rebuildCmd} {fastBuildShortProjectName} {fastbuildArguments}");
}
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);
}
