// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tools.DotNETCommon;
namespace UnrealBuildTool
{
///
/// A module that is compiled from C++ code.
///
class UEBuildModuleCPP : UEBuildModule
{
///
/// Stores a list of all source files, of different types
///
class InputFileCollection
{
public readonly List HeaderFiles = new List();
public readonly List CPPFiles = new List();
public readonly List CFiles = new List();
public readonly List CCFiles = new List();
public readonly List MMFiles = new List();
public readonly List RCFiles = new List();
public readonly List ISPCFiles = new List();
}
///
/// The directory for this module's object files
///
public readonly DirectoryReference IntermediateDirectory;
///
/// The directory for this module's generated code
///
public readonly DirectoryReference GeneratedCodeDirectory;
///
/// Set for modules that have generated code
///
public bool bAddGeneratedCodeIncludePath;
///
/// Wildcard matching the *.gen.cpp files for this module. If this is null then this module doesn't have any UHT-produced code.
///
public string GeneratedCodeWildcard;
///
/// List of invalid include directives. These are buffered up and output before we start compiling.
///
public List InvalidIncludeDirectiveMessages;
///
/// Set of source directories referenced during a build
///
HashSet SourceDirectories;
protected override void GetReferencedDirectories(HashSet Directories)
{
base.GetReferencedDirectories(Directories);
if(!Rules.bUsePrecompiled)
{
if(SourceDirectories == null)
{
throw new BuildException("GetReferencedDirectories() should not be called before building.");
}
Directories.UnionWith(SourceDirectories);
}
}
///
/// List of whitelisted circular dependencies. Please do NOT add new modules here; refactor to allow the modules to be decoupled instead.
///
static readonly KeyValuePair[] WhitelistedCircularDependencies =
{
new KeyValuePair("Engine", "Landscape"),
new KeyValuePair("Engine", "UMG"),
new KeyValuePair("Engine", "GameplayTags"),
new KeyValuePair("Engine", "MaterialShaderQualitySettings"),
new KeyValuePair("Engine", "UnrealEd"),
new KeyValuePair("Engine", "AudioMixer"),
new KeyValuePair("PacketHandler", "ReliabilityHandlerComponent"),
new KeyValuePair("GameplayDebugger", "AIModule"),
new KeyValuePair("GameplayDebugger", "GameplayTasks"),
new KeyValuePair("Engine", "CinematicCamera"),
new KeyValuePair("Engine", "CollisionAnalyzer"),
new KeyValuePair("Engine", "LogVisualizer"),
new KeyValuePair("Engine", "Kismet"),
new KeyValuePair("Landscape", "UnrealEd"),
new KeyValuePair("Landscape", "MaterialUtilities"),
new KeyValuePair("LocalizationDashboard", "LocalizationService"),
new KeyValuePair("LocalizationDashboard", "MainFrame"),
new KeyValuePair("LocalizationDashboard", "TranslationEditor"),
new KeyValuePair("Documentation", "SourceControl"),
new KeyValuePair("UnrealEd", "GraphEditor"),
new KeyValuePair("UnrealEd", "Kismet"),
new KeyValuePair("UnrealEd", "AudioEditor"),
new KeyValuePair("BlueprintGraph", "KismetCompiler"),
new KeyValuePair("BlueprintGraph", "UnrealEd"),
new KeyValuePair("BlueprintGraph", "GraphEditor"),
new KeyValuePair("BlueprintGraph", "Kismet"),
new KeyValuePair("BlueprintGraph", "CinematicCamera"),
new KeyValuePair("ConfigEditor", "PropertyEditor"),
new KeyValuePair("SourceControl", "UnrealEd"),
new KeyValuePair("Kismet", "BlueprintGraph"),
new KeyValuePair("Kismet", "UMGEditor"),
new KeyValuePair("MovieSceneTools", "Sequencer"),
new KeyValuePair("Sequencer", "MovieSceneTools"),
new KeyValuePair("AIModule", "AITestSuite"),
new KeyValuePair("GameplayTasks", "UnrealEd"),
new KeyValuePair("AnimGraph", "UnrealEd"),
new KeyValuePair("AnimGraph", "GraphEditor"),
new KeyValuePair("MaterialUtilities", "Landscape"),
new KeyValuePair("HierarchicalLODOutliner", "UnrealEd"),
new KeyValuePair("PixelInspectorModule", "UnrealEd"),
new KeyValuePair("GameplayAbilitiesEditor", "BlueprintGraph"),
new KeyValuePair("UnrealEd", "ViewportInteraction"),
new KeyValuePair("UnrealEd", "VREditor"),
new KeyValuePair("LandscapeEditor", "ViewportInteraction"),
new KeyValuePair("LandscapeEditor", "VREditor"),
new KeyValuePair("FoliageEdit", "ViewportInteraction"),
new KeyValuePair("FoliageEdit", "VREditor"),
new KeyValuePair("MeshPaint", "ViewportInteraction"),
new KeyValuePair("MeshPaint", "VREditor"),
new KeyValuePair("MeshPaintMode", "ViewportInteraction"),
new KeyValuePair("MeshPaintMode", "VREditor"),
new KeyValuePair("Sequencer", "ViewportInteraction"),
new KeyValuePair("NavigationSystem", "UnrealEd"),
};
public UEBuildModuleCPP(ModuleRules Rules, DirectoryReference IntermediateDirectory, DirectoryReference GeneratedCodeDirectory)
: base(Rules)
{
this.IntermediateDirectory = IntermediateDirectory;
this.GeneratedCodeDirectory = GeneratedCodeDirectory;
foreach (string Def in PublicDefinitions)
{
Log.TraceVerbose("Compile Env {0}: {1}", Name, Def);
}
foreach (string Def in Rules.PrivateDefinitions)
{
Log.TraceVerbose("Compile Env {0}: {1}", Name, Def);
}
foreach(string CircularlyReferencedModuleName in Rules.CircularlyReferencedDependentModules)
{
if(CircularlyReferencedModuleName != "BlueprintContext" && !WhitelistedCircularDependencies.Any(x => x.Key == Name && x.Value == CircularlyReferencedModuleName))
{
Log.TraceWarning("Found reference between '{0}' and '{1}'. Support for circular references is being phased out; please do not introduce new ones.", Name, CircularlyReferencedModuleName);
}
}
AddDefaultIncludePaths();
}
///
/// Add the default include paths for this module to its settings
///
private void AddDefaultIncludePaths()
{
// Add the module's parent directory to the public include paths, so other modules may include headers from it explicitly.
foreach (DirectoryReference ModuleDir in ModuleDirectories)
{
PublicIncludePaths.Add(ModuleDir.ParentDirectory);
// Add the base directory to the legacy include paths.
LegacyPublicIncludePaths.Add(ModuleDir);
// Add the 'classes' directory, if it exists
DirectoryReference ClassesDirectory = DirectoryReference.Combine(ModuleDir, "Classes");
if (DirectoryLookupCache.DirectoryExists(ClassesDirectory))
{
PublicIncludePaths.Add(ClassesDirectory);
}
// Add all the public directories
DirectoryReference PublicDirectory = DirectoryReference.Combine(ModuleDir, "Public");
if (DirectoryLookupCache.DirectoryExists(PublicDirectory))
{
PublicIncludePaths.Add(PublicDirectory);
ReadOnlyHashSet ExcludeNames = UEBuildPlatform.GetBuildPlatform(Rules.Target.Platform).GetExcludedFolderNames();
EnumerateLegacyIncludePaths(DirectoryItem.GetItemByDirectoryReference(PublicDirectory), ExcludeNames, LegacyPublicIncludePaths);
}
// Add the base private directory for this module
DirectoryReference PrivateDirectory = DirectoryReference.Combine(ModuleDir, "Private");
if (DirectoryLookupCache.DirectoryExists(PrivateDirectory))
{
PrivateIncludePaths.Add(PrivateDirectory);
}
}
}
///
/// Enumerates legacy include paths under a given base directory
///
/// The directory to start from. This directory is not added to the output list.
/// Set of folder names to exclude from the search.
/// List populated with the discovered directories
static void EnumerateLegacyIncludePaths(DirectoryItem BaseDirectory, ReadOnlyHashSet ExcludeNames, HashSet LegacyPublicIncludePaths)
{
foreach(DirectoryItem SubDirectory in BaseDirectory.EnumerateDirectories())
{
if(!ExcludeNames.Contains(SubDirectory.Name))
{
LegacyPublicIncludePaths.Add(SubDirectory.Location);
EnumerateLegacyIncludePaths(SubDirectory, ExcludeNames, LegacyPublicIncludePaths);
}
}
}
///
/// Path to the precompiled manifest location
///
public virtual FileReference PrecompiledManifestLocation
{
get { return FileReference.Combine(IntermediateDirectory, String.Format("{0}.precompiled", Name)); }
}
///
/// Sets up the environment for compiling any module that includes the public interface of this module.
///
public override void AddModuleToCompileEnvironment(
UEBuildBinary SourceBinary,
HashSet IncludePaths,
HashSet SystemIncludePaths,
List Definitions,
List AdditionalFrameworks,
bool bLegacyPublicIncludePaths,
// @ATG_CHANGE : BEGIN - winmd support
List WinMDFiles
// @ATG_CHANGE : END - winmd support
)
{
// This directory may not exist for this module (or ever exist, if it doesn't contain any generated headers), but we want the project files
// to search it so we can pick up generated code definitions after UHT is run for the first time.
if(bAddGeneratedCodeIncludePath || (ProjectFileGenerator.bGenerateProjectFiles && GeneratedCodeDirectory != null))
{
IncludePaths.Add(GeneratedCodeDirectory);
}
// @ATG_CHANGE : BEGIN - winmd support
base.AddModuleToCompileEnvironment(SourceBinary, IncludePaths, SystemIncludePaths, Definitions, AdditionalFrameworks, bLegacyPublicIncludePaths, WinMDFiles);
// @ATG_CHANGE : END - winmd support
}
// UEBuildModule interface.
public override List Compile(ReadOnlyTargetRules Target, UEToolChain ToolChain, CppCompileEnvironment BinaryCompileEnvironment, ISourceFileWorkingSet WorkingSet, TargetMakefile Makefile)
{
UEBuildPlatform BuildPlatform = UEBuildPlatform.GetBuildPlatform(BinaryCompileEnvironment.Platform);
List LinkInputFiles = new List();
CppCompileEnvironment ModuleCompileEnvironment = CreateModuleCompileEnvironment(Target, BinaryCompileEnvironment);
// If the module is precompiled, read the object files from the manifest
if(Rules.bUsePrecompiled && Target.LinkType == TargetLinkType.Monolithic)
{
if(!FileReference.Exists(PrecompiledManifestLocation))
{
throw new BuildException("Missing precompiled manifest for '{0}'. This module was most likely not flagged for being included in a precompiled build - set 'PrecompileForTargets = PrecompileTargetsType.Any;' in {0}.build.cs to override.", Name);
}
PrecompiledManifest Manifest = PrecompiledManifest.Read(PrecompiledManifestLocation);
foreach(FileReference OutputFile in Manifest.OutputFiles)
{
FileItem ObjectFile = FileItem.GetItemByFileReference(OutputFile);
if(!ObjectFile.Exists)
{
throw new BuildException("Missing object file {0} listed in {1}", OutputFile, PrecompiledManifestLocation);
}
LinkInputFiles.Add(ObjectFile);
}
return LinkInputFiles;
}
// Find all the input files
InputFileCollection InputFiles = FindInputFiles(Target.Platform, Makefile);
// Process all of the header file dependencies for this module
CheckFirstIncludeMatchesEachCppFile(Target, ModuleCompileEnvironment, InputFiles.HeaderFiles, InputFiles.CPPFiles);
// Should we force a precompiled header to be generated for this module? Usually, we only bother with a
// precompiled header if there are at least several source files in the module (after combining them for unity
// builds.) But for game modules, it can be convenient to always have a precompiled header to single-file
// changes to code is really quick to compile.
int MinFilesUsingPrecompiledHeader = Target.MinFilesUsingPrecompiledHeader;
if (Rules.MinFilesUsingPrecompiledHeaderOverride != 0)
{
MinFilesUsingPrecompiledHeader = Rules.MinFilesUsingPrecompiledHeaderOverride;
}
else if (!Rules.bTreatAsEngineModule && Target.bForcePrecompiledHeaderForGameModules)
{
// This is a game module with only a small number of source files, so go ahead and force a precompiled header
// to be generated to make incremental changes to source files as fast as possible for small projects.
MinFilesUsingPrecompiledHeader = 1;
}
// Engine modules will always use unity build mode unless MinSourceFilesForUnityBuildOverride is specified in
// the module rules file. By default, game modules only use unity of they have enough source files for that
// to be worthwhile. If you have a lot of small game modules, consider specifying MinSourceFilesForUnityBuildOverride=0
// in the modules that you don't typically iterate on source files in very frequently.
int MinSourceFilesForUnityBuild = 2;
if (Rules.MinSourceFilesForUnityBuildOverride != 0)
{
MinSourceFilesForUnityBuild = Rules.MinSourceFilesForUnityBuildOverride;
}
else if (Target.ProjectFile != null && RulesFile.IsUnderDirectory(DirectoryReference.Combine(Target.ProjectFile.Directory, "Source")))
{
// Game modules with only a small number of source files are usually better off having faster iteration times
// on single source file changes, so we forcibly disable unity build for those modules
MinSourceFilesForUnityBuild = Target.MinGameModuleSourceFilesForUnityBuild;
}
// Should we use unity build mode for this module?
bool bModuleUsesUnityBuild = false;
if (Target.bUseUnityBuild || Target.bForceUnityBuild)
{
if (Target.bForceUnityBuild)
{
Log.TraceVerbose("Module '{0}' using unity build mode (bForceUnityBuild enabled for this module)", this.Name);
bModuleUsesUnityBuild = true;
}
else if (Rules.bFasterWithoutUnity)
{
Log.TraceVerbose("Module '{0}' not using unity build mode (bFasterWithoutUnity enabled for this module)", this.Name);
bModuleUsesUnityBuild = false;
}
else if (InputFiles.CPPFiles.Count < MinSourceFilesForUnityBuild)
{
Log.TraceVerbose("Module '{0}' not using unity build mode (module with fewer than {1} source files)", this.Name, MinSourceFilesForUnityBuild);
bModuleUsesUnityBuild = false;
}
else
{
Log.TraceVerbose("Module '{0}' using unity build mode", this.Name);
bModuleUsesUnityBuild = true;
}
}
else
{
Log.TraceVerbose("Module '{0}' not using unity build mode", this.Name);
}
// Set up the environment with which to compile the CPP files
CppCompileEnvironment CompileEnvironment = ModuleCompileEnvironment;
// Generate ISPC headers first so C++ can consume them
if (InputFiles.ISPCFiles.Count > 0)
{
CreateHeadersForISPC(ToolChain, CompileEnvironment, InputFiles.ISPCFiles, IntermediateDirectory, Makefile.Actions);
}
if (Target.bUsePCHFiles && Rules.PCHUsage != ModuleRules.PCHUsageMode.NoPCHs)
{
// If this module doesn't need a shared PCH, configure that
if(Rules.PrivatePCHHeaderFile != null && (Rules.PCHUsage == ModuleRules.PCHUsageMode.NoSharedPCHs || Rules.PCHUsage == ModuleRules.PCHUsageMode.UseExplicitOrSharedPCHs))
{
PrecompiledHeaderInstance Instance = CreatePrivatePCH(ToolChain, FileItem.GetItemByFileReference(FileReference.Combine(ModuleDirectory, Rules.PrivatePCHHeaderFile)), CompileEnvironment, Makefile.Actions);
CompileEnvironment = new CppCompileEnvironment(CompileEnvironment);
CompileEnvironment.Definitions.Clear();
CompileEnvironment.PrecompiledHeaderAction = PrecompiledHeaderAction.Include;
CompileEnvironment.PrecompiledHeaderIncludeFilename = Instance.HeaderFile.Location;
CompileEnvironment.PrecompiledHeaderFile = Instance.Output.PrecompiledHeaderFile;
LinkInputFiles.AddRange(Instance.Output.ObjectFiles);
}
// Try to find a suitable shared PCH for this module
if (CompileEnvironment.PrecompiledHeaderFile == null && CompileEnvironment.SharedPCHs.Count > 0 && !CompileEnvironment.bIsBuildingLibrary && Rules.PCHUsage != ModuleRules.PCHUsageMode.NoSharedPCHs)
{
// Find all the dependencies of this module
HashSet ReferencedModules = new HashSet();
GetAllDependencyModules(new List(), ReferencedModules, bIncludeDynamicallyLoaded: false, bForceCircular: false, bOnlyDirectDependencies: true);
// Find the first shared PCH module we can use
PrecompiledHeaderTemplate Template = CompileEnvironment.SharedPCHs.FirstOrDefault(x => ReferencedModules.Contains(x.Module));
if(Template != null && Template.IsValidFor(CompileEnvironment))
{
PrecompiledHeaderInstance Instance = FindOrCreateSharedPCH(ToolChain, Template, ModuleCompileEnvironment, Makefile.Actions);
FileReference PrivateDefinitionsFile = FileReference.Combine(IntermediateDirectory, String.Format("Definitions.{0}.h", Name));
FileItem PrivateDefinitionsFileItem;
using (StringWriter Writer = new StringWriter())
{
// Remove the module _API definition for cases where there are circular dependencies between the shared PCH module and modules using it
Writer.WriteLine("#undef {0}", ModuleApiDefine);
Writer.WriteLine("#undef {0}", ModuleVTableDefine);
// Games may choose to use shared PCHs from the engine, so allow them to change the value of these macros
if(!Rules.bTreatAsEngineModule)
{
Writer.WriteLine("#undef UE_IS_ENGINE_MODULE");
Writer.WriteLine("#undef DEPRECATED_FORGAME");
Writer.WriteLine("#define DEPRECATED_FORGAME DEPRECATED");
Writer.WriteLine("#undef UE_DEPRECATED_FORGAME");
Writer.WriteLine("#define UE_DEPRECATED_FORGAME UE_DEPRECATED");
}
WriteDefinitions(CompileEnvironment.Definitions, Writer);
PrivateDefinitionsFileItem = FileItem.CreateIntermediateTextFile(PrivateDefinitionsFile, Writer.ToString());
}
CompileEnvironment = new CppCompileEnvironment(CompileEnvironment);
CompileEnvironment.Definitions.Clear();
CompileEnvironment.ForceIncludeFiles.Add(PrivateDefinitionsFileItem);
CompileEnvironment.PrecompiledHeaderAction = PrecompiledHeaderAction.Include;
CompileEnvironment.PrecompiledHeaderIncludeFilename = Instance.HeaderFile.Location;
CompileEnvironment.PrecompiledHeaderFile = Instance.Output.PrecompiledHeaderFile;
LinkInputFiles.AddRange(Instance.Output.ObjectFiles);
}
}
}
// Write all the definitions to a separate file
CreateHeaderForDefinitions(CompileEnvironment, IntermediateDirectory, null);
// Mapping of source file to unity file. We output this to intermediate directories for other tools (eg. live coding) to use.
Dictionary SourceFileToUnityFile = new Dictionary();
// Compile CPP files
List CPPFilesToCompile = InputFiles.CPPFiles;
if (bModuleUsesUnityBuild)
{
CPPFilesToCompile = Unity.GenerateUnityCPPs(Target, CPPFilesToCompile, CompileEnvironment, WorkingSet, Rules.ShortName ?? Name, IntermediateDirectory, Makefile, SourceFileToUnityFile);
LinkInputFiles.AddRange(CompileUnityFilesWithToolChain(Target, ToolChain, CompileEnvironment, ModuleCompileEnvironment, CPPFilesToCompile, Makefile.Actions).ObjectFiles);
}
else
{
LinkInputFiles.AddRange(ToolChain.CompileCPPFiles(CompileEnvironment, CPPFilesToCompile, IntermediateDirectory, Name, Makefile.Actions).ObjectFiles);
}
// Compile all the generated CPP files
if (GeneratedCodeWildcard != null && !CompileEnvironment.bHackHeaderGenerator)
{
string[] GeneratedFiles = Directory.GetFiles(Path.GetDirectoryName(GeneratedCodeWildcard), Path.GetFileName(GeneratedCodeWildcard));
if(GeneratedFiles.Length > 0)
{
// Create a compile environment for the generated files. We can disable creating debug info here to improve link times.
CppCompileEnvironment GeneratedCPPCompileEnvironment = CompileEnvironment;
if(GeneratedCPPCompileEnvironment.bCreateDebugInfo && Target.bDisableDebugInfoForGeneratedCode)
{
GeneratedCPPCompileEnvironment = new CppCompileEnvironment(GeneratedCPPCompileEnvironment);
GeneratedCPPCompileEnvironment.bCreateDebugInfo = false;
}
// Always force include the PCH, even if PCHs are disabled, for generated code. Legacy code can rely on PCHs being included to compile correctly, and this used to be done by UHT manually including it.
if(GeneratedCPPCompileEnvironment.PrecompiledHeaderFile == null && Rules.PrivatePCHHeaderFile != null && Rules.PCHUsage != ModuleRules.PCHUsageMode.UseExplicitOrSharedPCHs)
{
FileItem PrivatePchFileItem = FileItem.GetItemByFileReference(FileReference.Combine(ModuleDirectory, Rules.PrivatePCHHeaderFile));
if(!PrivatePchFileItem.Exists)
{
throw new BuildException("Unable to find private PCH file '{0}', referenced by '{1}'", PrivatePchFileItem.Location, RulesFile);
}
GeneratedCPPCompileEnvironment = new CppCompileEnvironment(GeneratedCPPCompileEnvironment);
GeneratedCPPCompileEnvironment.ForceIncludeFiles.Add(PrivatePchFileItem);
}
// Compile all the generated files
List GeneratedFileItems = new List();
foreach (string GeneratedFilename in GeneratedFiles)
{
FileItem GeneratedCppFileItem = FileItem.GetItemByPath(GeneratedFilename);
// @todo ubtmake: Check for ALL other places where we might be injecting .cpp or .rc files for compiling without caching CachedCPPIncludeInfo first (anything platform specific?)
GeneratedFileItems.Add(GeneratedCppFileItem);
}
if (bModuleUsesUnityBuild)
{
GeneratedFileItems = Unity.GenerateUnityCPPs(Target, GeneratedFileItems, GeneratedCPPCompileEnvironment, WorkingSet, (Rules.ShortName ?? Name) + ".gen", IntermediateDirectory, Makefile, SourceFileToUnityFile);
LinkInputFiles.AddRange(CompileUnityFilesWithToolChain(Target, ToolChain, GeneratedCPPCompileEnvironment, ModuleCompileEnvironment, GeneratedFileItems, Makefile.Actions).ObjectFiles);
}
else
{
LinkInputFiles.AddRange(ToolChain.CompileCPPFiles(GeneratedCPPCompileEnvironment, GeneratedFileItems, IntermediateDirectory, Name, Makefile.Actions).ObjectFiles);
}
}
}
// Compile ISPC files directly
if (InputFiles.ISPCFiles.Count > 0)
{
LinkInputFiles.AddRange(ToolChain.CompileISPCFiles(CompileEnvironment, InputFiles.ISPCFiles, IntermediateDirectory, Makefile.Actions).ObjectFiles);
}
// Compile C files directly. Do not use a PCH here, because a C++ PCH is not compatible with C source files.
if(InputFiles.CFiles.Count > 0)
{
LinkInputFiles.AddRange(ToolChain.CompileCPPFiles(ModuleCompileEnvironment, InputFiles.CFiles, IntermediateDirectory, Name, Makefile.Actions).ObjectFiles);
}
// Compile CC files directly.
if(InputFiles.CCFiles.Count > 0)
{
LinkInputFiles.AddRange(ToolChain.CompileCPPFiles(CompileEnvironment, InputFiles.CCFiles, IntermediateDirectory, Name, Makefile.Actions).ObjectFiles);
}
// Compile MM files directly.
if(InputFiles.MMFiles.Count > 0)
{
LinkInputFiles.AddRange(ToolChain.CompileCPPFiles(CompileEnvironment, InputFiles.MMFiles, IntermediateDirectory, Name, Makefile.Actions).ObjectFiles);
}
// Compile RC files. The resource compiler does not work with response files, and using the regular compile environment can easily result in the
// command line length exceeding the OS limit. Use the binary compile environment to keep the size down, and require that all include paths
// must be specified relative to the resource file itself or Engine/Source.
if(InputFiles.RCFiles.Count > 0)
{
CppCompileEnvironment ResourceCompileEnvironment = new CppCompileEnvironment(BinaryCompileEnvironment);
if(Binary != null)
{
// @todo: This should be in some Windows code somewhere...
ResourceCompileEnvironment.Definitions.Add("ORIGINAL_FILE_NAME=\"" + Binary.OutputFilePaths[0].GetFileName() + "\"");
}
LinkInputFiles.AddRange(ToolChain.CompileRCFiles(ResourceCompileEnvironment, InputFiles.RCFiles, IntermediateDirectory, Makefile.Actions).ObjectFiles);
}
// Write the compiled manifest
if(Rules.bPrecompile && Target.LinkType == TargetLinkType.Monolithic)
{
DirectoryReference.CreateDirectory(PrecompiledManifestLocation.Directory);
PrecompiledManifest Manifest = new PrecompiledManifest();
Manifest.OutputFiles.AddRange(LinkInputFiles.Select(x => x.Location));
Manifest.WriteIfModified(PrecompiledManifestLocation);
}
// Write a mapping of unity object file to standalone object file for live coding
if(Rules.Target.bWithLiveCoding)
{
FileReference UnityManifestFile = FileReference.Combine(IntermediateDirectory, "LiveCodingInfo.json");
using (JsonWriter Writer = new JsonWriter(UnityManifestFile))
{
Writer.WriteObjectStart();
Writer.WriteObjectStart("RemapUnityFiles");
foreach (IGrouping> UnityGroup in SourceFileToUnityFile.GroupBy(x => x.Value))
{
Writer.WriteArrayStart(UnityGroup.Key.Location.GetFileName() + ".obj");
foreach (FileItem SourceFile in UnityGroup.Select(x => x.Key))
{
Writer.WriteValue(SourceFile.Location.GetFileName() + ".obj");
}
Writer.WriteArrayEnd();
}
Writer.WriteObjectEnd();
Writer.WriteObjectEnd();
}
}
return LinkInputFiles;
}
///
/// Create a shared PCH template for this module, which allows constructing shared PCH instances in the future
///
/// The target which owns this module
/// Base compile environment for this target
/// Template for shared PCHs
public PrecompiledHeaderTemplate CreateSharedPCHTemplate(UEBuildTarget Target, CppCompileEnvironment BaseCompileEnvironment)
{
CppCompileEnvironment CompileEnvironment = CreateSharedPCHCompileEnvironment(Target, BaseCompileEnvironment);
FileItem HeaderFile = FileItem.GetItemByFileReference(FileReference.Combine(ModuleDirectory, Rules.SharedPCHHeaderFile));
DirectoryReference PrecompiledHeaderDir;
if(Rules.bUsePrecompiled)
{
PrecompiledHeaderDir = DirectoryReference.Combine(Target.ProjectIntermediateDirectory, Name);
}
else
{
PrecompiledHeaderDir = IntermediateDirectory;
}
return new PrecompiledHeaderTemplate(this, CompileEnvironment, HeaderFile, PrecompiledHeaderDir);
}
///
/// Creates a precompiled header action to generate a new pch file
///
/// The toolchain to generate the PCH
///
///
/// List of actions to be executed. Additional actions will be added to this list.
/// The created PCH instance.
private PrecompiledHeaderInstance CreatePrivatePCH(UEToolChain ToolChain, FileItem HeaderFile, CppCompileEnvironment ModuleCompileEnvironment, List Actions)
{
// Create the wrapper file, which sets all the definitions needed to compile it
FileReference WrapperLocation = FileReference.Combine(IntermediateDirectory, String.Format("PCH.{0}.h", Name));
FileItem WrapperFile = CreatePCHWrapperFile(WrapperLocation, ModuleCompileEnvironment.Definitions, HeaderFile);
// Create a new C++ environment that is used to create the PCH.
CppCompileEnvironment CompileEnvironment = new CppCompileEnvironment(ModuleCompileEnvironment);
CompileEnvironment.Definitions.Clear();
CompileEnvironment.PrecompiledHeaderAction = PrecompiledHeaderAction.Create;
CompileEnvironment.PrecompiledHeaderIncludeFilename = WrapperFile.Location;
CompileEnvironment.bOptimizeCode = ModuleCompileEnvironment.bOptimizeCode;
// Create the action to compile the PCH file.
CPPOutput Output = ToolChain.CompileCPPFiles(CompileEnvironment, new List() { WrapperFile }, IntermediateDirectory, Name, Actions);
return new PrecompiledHeaderInstance(WrapperFile, CompileEnvironment, Output);
}
///
/// Generates a precompiled header instance from the given template, or returns an existing one if it already exists
///
/// The toolchain being used to build this module
/// The PCH template
/// Compile environment for the current module
/// List of actions to be executed. Additional actions will be added to this list.
/// Instance of a PCH
public PrecompiledHeaderInstance FindOrCreateSharedPCH(UEToolChain ToolChain, PrecompiledHeaderTemplate Template, CppCompileEnvironment ModuleCompileEnvironment, List Actions)
{
PrecompiledHeaderInstance Instance = Template.Instances.Find(x => IsCompatibleForSharedPCH(x.CompileEnvironment, ModuleCompileEnvironment));
if(Instance == null)
{
// Create a suffix to distinguish this shared PCH variant from any others. Currently only optimized and non-optimized shared PCHs are supported.
string Variant = GetSuffixForSharedPCH(ModuleCompileEnvironment, Template.BaseCompileEnvironment);
// Create the wrapper file, which sets all the definitions needed to compile it
FileReference WrapperLocation = FileReference.Combine(Template.OutputDir, String.Format("SharedPCH.{0}{1}.h", Template.Module.Name, Variant));
FileItem WrapperFile = CreatePCHWrapperFile(WrapperLocation, Template.BaseCompileEnvironment.Definitions, Template.HeaderFile);
// Create the compile environment for this PCH
CppCompileEnvironment CompileEnvironment = new CppCompileEnvironment(Template.BaseCompileEnvironment);
CompileEnvironment.Definitions.Clear();
CompileEnvironment.PrecompiledHeaderAction = PrecompiledHeaderAction.Create;
CompileEnvironment.PrecompiledHeaderIncludeFilename = WrapperFile.Location;
CopySettingsForSharedPCH(ModuleCompileEnvironment, CompileEnvironment);
// Create the PCH
CPPOutput Output = ToolChain.CompileCPPFiles(CompileEnvironment, new List() { WrapperFile }, Template.OutputDir, "Shared", Actions);
Instance = new PrecompiledHeaderInstance(WrapperFile, CompileEnvironment, Output);
Template.Instances.Add(Instance);
}
return Instance;
}
///
/// Determines if a module compile environment is compatible with the given shared PCH compile environment
///
/// The module compile environment
/// The shared PCH compile environment
/// True if the two compile enviroments are compatible
private bool IsCompatibleForSharedPCH(CppCompileEnvironment ModuleCompileEnvironment, CppCompileEnvironment CompileEnvironment)
{
if(ModuleCompileEnvironment.bOptimizeCode != CompileEnvironment.bOptimizeCode)
{
return false;
}
if(ModuleCompileEnvironment.bUseRTTI != CompileEnvironment.bUseRTTI)
{
return false;
}
if(ModuleCompileEnvironment.bEnableExceptions != CompileEnvironment.bEnableExceptions)
{
return false;
}
if(ModuleCompileEnvironment.bEnableShadowVariableWarnings != CompileEnvironment.bEnableShadowVariableWarnings)
{
return false;
}
if(ModuleCompileEnvironment.bEnableUndefinedIdentifierWarnings != CompileEnvironment.bEnableUndefinedIdentifierWarnings)
{
return false;
}
return true;
}
///
/// Gets the unique suffix for a shared PCH
///
/// The shared PCH compile environment
/// The base compile environment
/// The unique suffix for the shared PCH
private string GetSuffixForSharedPCH(CppCompileEnvironment CompileEnvironment, CppCompileEnvironment BaseCompileEnvironment)
{
string Variant = "";
if(CompileEnvironment.bOptimizeCode != BaseCompileEnvironment.bOptimizeCode)
{
if(CompileEnvironment.bOptimizeCode)
{
Variant += ".Optimized";
}
else
{
Variant += ".NonOptimized";
}
}
if(CompileEnvironment.bUseRTTI != BaseCompileEnvironment.bUseRTTI)
{
if (CompileEnvironment.bUseRTTI)
{
Variant += ".RTTI";
}
else
{
Variant += ".NonRTTI";
}
}
if (CompileEnvironment.bEnableExceptions != BaseCompileEnvironment.bEnableExceptions)
{
if (CompileEnvironment.bEnableExceptions)
{
Variant += ".Exceptions";
}
else
{
Variant += ".NoExceptions";
}
}
if (CompileEnvironment.bEnableShadowVariableWarnings != BaseCompileEnvironment.bEnableShadowVariableWarnings)
{
if (CompileEnvironment.bEnableShadowVariableWarnings)
{
Variant += ".Shadow";
}
else
{
Variant += ".NoShadow";
}
}
if (CompileEnvironment.bEnableUndefinedIdentifierWarnings != BaseCompileEnvironment.bEnableUndefinedIdentifierWarnings)
{
if (CompileEnvironment.bEnableUndefinedIdentifierWarnings)
{
Variant += ".Undef";
}
else
{
Variant += ".NoUndef";
}
}
return Variant;
}
///
/// Copy settings from the module's compile environment into the environment for the shared PCH
///
/// The module compile environment
/// The shared PCH compile environment
private void CopySettingsForSharedPCH(CppCompileEnvironment ModuleCompileEnvironment, CppCompileEnvironment CompileEnvironment)
{
CompileEnvironment.bOptimizeCode = ModuleCompileEnvironment.bOptimizeCode;
CompileEnvironment.bUseRTTI = ModuleCompileEnvironment.bUseRTTI;
CompileEnvironment.bEnableExceptions = ModuleCompileEnvironment.bEnableExceptions;
CompileEnvironment.bEnableShadowVariableWarnings = ModuleCompileEnvironment.bEnableShadowVariableWarnings;
CompileEnvironment.bEnableUndefinedIdentifierWarnings = ModuleCompileEnvironment.bEnableUndefinedIdentifierWarnings;
}
///
/// Compiles the provided CPP unity files. Will
///
private CPPOutput CompileUnityFilesWithToolChain(ReadOnlyTargetRules Target, UEToolChain ToolChain, CppCompileEnvironment CompileEnvironment, CppCompileEnvironment ModuleCompileEnvironment, List SourceFiles, List Actions)
{
List NormalFiles = new List();
List AdaptiveFiles = new List();
bool bAdaptiveUnityDisablesPCH = false;
if(Rules.PCHUsage == ModuleRules.PCHUsageMode.UseExplicitOrSharedPCHs)
{
if(Rules.bTreatAsEngineModule || Rules.PrivatePCHHeaderFile == null)
{
bAdaptiveUnityDisablesPCH = Target.bAdaptiveUnityDisablesPCH;
}
else
{
bAdaptiveUnityDisablesPCH = Target.bAdaptiveUnityDisablesPCHForProject;
}
}
if ((Target.bAdaptiveUnityDisablesOptimizations || bAdaptiveUnityDisablesPCH || Target.bAdaptiveUnityCreatesDedicatedPCH) && !Target.bStressTestUnity)
{
foreach (FileItem File in SourceFiles)
{
// Basic check as to whether something in this module is/isn't a unity file...
if (File.Location.GetFileName().StartsWith(Unity.ModulePrefix))
{
NormalFiles.Add(File);
}
else
{
AdaptiveFiles.Add(File);
}
}
}
else
{
NormalFiles.AddRange(SourceFiles);
}
CPPOutput OutputFiles = new CPPOutput();
if (NormalFiles.Count > 0)
{
OutputFiles = ToolChain.CompileCPPFiles(CompileEnvironment, NormalFiles, IntermediateDirectory, Name, Actions);
}
if (AdaptiveFiles.Count > 0)
{
// Create the new compile environment. Always turn off PCH due to different compiler settings.
CppCompileEnvironment AdaptiveUnityEnvironment = new CppCompileEnvironment(ModuleCompileEnvironment);
if(Target.bAdaptiveUnityDisablesOptimizations)
{
AdaptiveUnityEnvironment.bOptimizeCode = false;
}
if (Target.bAdaptiveUnityEnablesEditAndContinue)
{
AdaptiveUnityEnvironment.bSupportEditAndContinue = true;
}
// Create a per-file PCH
CPPOutput AdaptiveOutput;
if(Target.bAdaptiveUnityCreatesDedicatedPCH)
{
AdaptiveOutput = CompileAdaptiveNonUnityFilesWithDedicatedPCH(ToolChain, AdaptiveUnityEnvironment, AdaptiveFiles, IntermediateDirectory, Name, Actions);
}
else if(bAdaptiveUnityDisablesPCH)
{
AdaptiveOutput = CompileAdaptiveNonUnityFilesWithoutPCH(ToolChain, AdaptiveUnityEnvironment, AdaptiveFiles, IntermediateDirectory, Name, Actions);
}
else if(AdaptiveUnityEnvironment.bOptimizeCode != CompileEnvironment.bOptimizeCode || AdaptiveUnityEnvironment.bSupportEditAndContinue != CompileEnvironment.bSupportEditAndContinue)
{
AdaptiveOutput = CompileAdaptiveNonUnityFiles(ToolChain, AdaptiveUnityEnvironment, AdaptiveFiles, IntermediateDirectory, Name, Actions);
}
else
{
AdaptiveOutput = CompileAdaptiveNonUnityFiles(ToolChain, CompileEnvironment, AdaptiveFiles, IntermediateDirectory, Name, Actions);
}
// Merge output
OutputFiles.ObjectFiles.AddRange(AdaptiveOutput.ObjectFiles);
OutputFiles.DebugDataFiles.AddRange(AdaptiveOutput.DebugDataFiles);
}
return OutputFiles;
}
static CPPOutput CompileAdaptiveNonUnityFiles(UEToolChain ToolChain, CppCompileEnvironment CompileEnvironment, List Files, DirectoryReference IntermediateDirectory, string ModuleName, List Actions)
{
// Write all the definitions out to a separate file
CreateHeaderForDefinitions(CompileEnvironment, IntermediateDirectory, "Adaptive");
// Compile the files
return ToolChain.CompileCPPFiles(CompileEnvironment, Files, IntermediateDirectory, ModuleName, Actions);
}
static CPPOutput CompileAdaptiveNonUnityFilesWithoutPCH(UEToolChain ToolChain, CppCompileEnvironment CompileEnvironment, List Files, DirectoryReference IntermediateDirectory, string ModuleName, List Actions)
{
// Disable precompiled headers
CompileEnvironment.PrecompiledHeaderAction = PrecompiledHeaderAction.None;
// Write all the definitions out to a separate file
CreateHeaderForDefinitions(CompileEnvironment, IntermediateDirectory, "Adaptive");
// Compile the files
return ToolChain.CompileCPPFiles(CompileEnvironment, Files, IntermediateDirectory, ModuleName, Actions);
}
static CPPOutput CompileAdaptiveNonUnityFilesWithDedicatedPCH(UEToolChain ToolChain, CppCompileEnvironment CompileEnvironment, List Files, DirectoryReference IntermediateDirectory, string ModuleName, List Actions)
{
CPPOutput Output = new CPPOutput();
foreach(FileItem File in Files)
{
// Build the contents of the wrapper file
StringBuilder WrapperContents = new StringBuilder();
using (StringWriter Writer = new StringWriter(WrapperContents))
{
Writer.WriteLine("// Dedicated PCH for {0}", File.AbsolutePath);
Writer.WriteLine();
WriteDefinitions(CompileEnvironment.Definitions, Writer);
Writer.WriteLine();
using(StreamReader Reader = new StreamReader(File.Location.FullName))
{
CppIncludeParser.CopyIncludeDirectives(Reader, Writer);
}
}
// Write the PCH header
FileReference DedicatedPchLocation = FileReference.Combine(IntermediateDirectory, String.Format("PCH.Dedicated.{0}.h", File.Location.GetFileNameWithoutExtension()));
FileItem DedicatedPchFile = FileItem.CreateIntermediateTextFile(DedicatedPchLocation, WrapperContents.ToString());
// Create a new C++ environment to compile the PCH
CppCompileEnvironment PchEnvironment = new CppCompileEnvironment(CompileEnvironment);
PchEnvironment.Definitions.Clear();
PchEnvironment.UserIncludePaths.Add(File.Location.Directory); // Need to be able to include headers in the same directory as the source file
PchEnvironment.PrecompiledHeaderAction = PrecompiledHeaderAction.Create;
PchEnvironment.PrecompiledHeaderIncludeFilename = DedicatedPchFile.Location;
// Create the action to compile the PCH file.
CPPOutput PchOutput = ToolChain.CompileCPPFiles(PchEnvironment, new List() { DedicatedPchFile }, IntermediateDirectory, ModuleName, Actions);
Output.ObjectFiles.AddRange(PchOutput.ObjectFiles);
// Create a new C++ environment to compile the original file
CppCompileEnvironment FileEnvironment = new CppCompileEnvironment(CompileEnvironment);
FileEnvironment.Definitions.Clear();
FileEnvironment.PrecompiledHeaderAction = PrecompiledHeaderAction.Include;
FileEnvironment.PrecompiledHeaderIncludeFilename = DedicatedPchFile.Location;
FileEnvironment.PrecompiledHeaderFile = PchOutput.PrecompiledHeaderFile;
// Create the action to compile the PCH file.
CPPOutput FileOutput = ToolChain.CompileCPPFiles(FileEnvironment, new List() { File }, IntermediateDirectory, ModuleName, Actions);
Output.ObjectFiles.AddRange(FileOutput.ObjectFiles);
}
return Output;
}
///
/// Creates a header file containing all the preprocessor definitions for a compile environment, and force-include it. We allow a more flexible syntax for preprocessor definitions than
/// is typically allowed on the command line (allowing function macros or double-quote characters, for example). Ensuring all definitions are specified in a header files ensures consistent
/// behavior.
///
/// The compile environment
/// Directory to create the intermediate file
/// Suffix for the included file
static void CreateHeaderForDefinitions(CppCompileEnvironment CompileEnvironment, DirectoryReference IntermediateDirectory, string HeaderSuffix)
{
if(CompileEnvironment.Definitions.Count > 0)
{
StringBuilder PrivateDefinitionsName = new StringBuilder("Definitions");
if(!String.IsNullOrEmpty(HeaderSuffix))
{
PrivateDefinitionsName.Append('.');
PrivateDefinitionsName.Append(HeaderSuffix);
}
PrivateDefinitionsName.Append(".h");
FileReference PrivateDefinitionsFile = FileReference.Combine(IntermediateDirectory, PrivateDefinitionsName.ToString());
using (StringWriter Writer = new StringWriter())
{
WriteDefinitions(CompileEnvironment.Definitions, Writer);
CompileEnvironment.Definitions.Clear();
FileItem PrivateDefinitionsFileItem = FileItem.CreateIntermediateTextFile(PrivateDefinitionsFile, Writer.ToString());
CompileEnvironment.ForceIncludeFiles.Add(PrivateDefinitionsFileItem);
}
}
}
///
/// Creates header files from ISPC for inclusion and adds them as dependencies.
///
static void CreateHeadersForISPC(UEToolChain ToolChain, CppCompileEnvironment CompileEnvironment, List InputFiles, DirectoryReference IntermediateDirectory, List Actions)
{
CPPOutput Output = ToolChain.GenerateISPCHeaders(CompileEnvironment, InputFiles, IntermediateDirectory, Actions);
CompileEnvironment.AdditionalPrerequisites.AddRange(Output.GeneratedHeaderFiles);
CompileEnvironment.UserIncludePaths.Add(IntermediateDirectory);
}
///
/// Create a header file containing the module definitions, which also includes the PCH itself. Including through another file is necessary on
/// Clang, since we get warnings about #pragma once otherwise, but it also allows us to consistently define the preprocessor state on all
/// platforms.
///
/// The output file to create
/// Definitions required by the PCH
/// The PCH file to include
/// FileItem for the created file
static FileItem CreatePCHWrapperFile(FileReference OutputFile, IEnumerable Definitions, FileItem IncludedFile)
{
// Build the contents of the wrapper file
StringBuilder WrapperContents = new StringBuilder();
using (StringWriter Writer = new StringWriter(WrapperContents))
{
Writer.WriteLine("// PCH for {0}", IncludedFile.AbsolutePath);
WriteDefinitions(Definitions, Writer);
Writer.WriteLine("#include \"{0}\"", IncludedFile.AbsolutePath.Replace('\\', '/'));
}
// Create the item
FileItem WrapperFile = FileItem.CreateIntermediateTextFile(OutputFile, WrapperContents.ToString());
// Touch it if the included file is newer, to make sure our timestamp dependency checking is accurate.
if (IncludedFile.LastWriteTimeUtc > WrapperFile.LastWriteTimeUtc)
{
File.SetLastWriteTimeUtc(WrapperFile.AbsolutePath, DateTime.UtcNow);
WrapperFile.ResetCachedInfo();
}
return WrapperFile;
}
///
/// Write a list of macro definitions to an output file
///
/// List of definitions
/// Writer to receive output
static void WriteDefinitions(IEnumerable Definitions, TextWriter Writer)
{
foreach(string Definition in Definitions)
{
int EqualsIdx = Definition.IndexOf('=');
if(EqualsIdx == -1)
{
Writer.WriteLine("#define {0} 1", Definition);
}
else
{
Writer.WriteLine("#define {0} {1}", Definition.Substring(0, EqualsIdx), Definition.Substring(EqualsIdx + 1));
}
}
}
///
/// Checks that the first header included by the source files in this module all include the same header
///
/// The target being compiled
/// Compile environment for the module
/// All header files for this module
/// List of C++ source files
private void CheckFirstIncludeMatchesEachCppFile(ReadOnlyTargetRules Target, CppCompileEnvironment ModuleCompileEnvironment, List HeaderFiles, List CppFiles)
{
if(Rules.PCHUsage == ModuleRules.PCHUsageMode.UseExplicitOrSharedPCHs)
{
if(InvalidIncludeDirectiveMessages == null)
{
// Find headers used by the source file.
Dictionary NameToHeaderFile = new Dictionary();
foreach(FileItem HeaderFile in HeaderFiles)
{
NameToHeaderFile[HeaderFile.Location.GetFileNameWithoutExtension()] = HeaderFile.Location;
}
// Find the directly included files for each source file, and make sure it includes the matching header if possible
InvalidIncludeDirectiveMessages = new List();
if (Rules != null && Rules.bEnforceIWYU && Target.bEnforceIWYU)
{
foreach (FileItem CppFile in CppFiles)
{
string FirstInclude = ModuleCompileEnvironment.MetadataCache.GetFirstInclude(CppFile);
if(FirstInclude != null)
{
string IncludeName = Path.GetFileNameWithoutExtension(FirstInclude);
string ExpectedName = CppFile.Location.GetFileNameWithoutExtension();
if (String.Compare(IncludeName, ExpectedName, StringComparison.OrdinalIgnoreCase) != 0)
{
FileReference HeaderFile;
if (NameToHeaderFile.TryGetValue(ExpectedName, out HeaderFile) && !IgnoreMismatchedHeader(ExpectedName))
{
InvalidIncludeDirectiveMessages.Add(String.Format("{0}(1): error: Expected {1} to be first header included.", CppFile.Location, HeaderFile.GetFileName()));
}
}
}
}
}
}
}
}
private bool IgnoreMismatchedHeader(string ExpectedName)
{
switch(ExpectedName)
{
case "DynamicRHI":
case "RHICommandList":
case "RHIUtilities":
return true;
}
switch(Name)
{
case "D3D11RHI":
case "D3D12RHI":
case "VulkanRHI":
case "OpenGLDrv":
case "MetalRHI":
case "PS4RHI":
case "Gnmx":
return true;
}
return false;
}
///
/// Determine whether optimization should be enabled for a given target
///
/// The optimization setting from the rules file
/// The active target configuration
/// Whether the current module is an engine module
/// True if optimization should be enabled
public static bool ShouldEnableOptimization(ModuleRules.CodeOptimization Setting, UnrealTargetConfiguration Configuration, bool bIsEngineModule)
{
switch(Setting)
{
case ModuleRules.CodeOptimization.Never:
return false;
case ModuleRules.CodeOptimization.Default:
case ModuleRules.CodeOptimization.InNonDebugBuilds:
return (Configuration == UnrealTargetConfiguration.Debug)? false : (Configuration != UnrealTargetConfiguration.DebugGame || bIsEngineModule);
case ModuleRules.CodeOptimization.InShippingBuildsOnly:
return (Configuration == UnrealTargetConfiguration.Shipping);
default:
return true;
}
}
///
/// Creates a compile environment from a base environment based on the module settings.
///
/// Rules for the target being built
/// An existing environment to base the module compile environment on.
/// The new module compile environment.
public CppCompileEnvironment CreateModuleCompileEnvironment(ReadOnlyTargetRules Target, CppCompileEnvironment BaseCompileEnvironment)
{
CppCompileEnvironment Result = new CppCompileEnvironment(BaseCompileEnvironment);
// Override compile environment
Result.bFasterWithoutUnity = Rules.bFasterWithoutUnity;
Result.bOptimizeCode = ShouldEnableOptimization(Rules.OptimizeCode, Target.Configuration, Rules.bTreatAsEngineModule);
Result.bUseRTTI |= Rules.bUseRTTI;
Result.bUseAVX = Rules.bUseAVX;
Result.bEnableBufferSecurityChecks = Rules.bEnableBufferSecurityChecks;
Result.MinSourceFilesForUnityBuildOverride = Rules.MinSourceFilesForUnityBuildOverride;
Result.MinFilesUsingPrecompiledHeaderOverride = Rules.MinFilesUsingPrecompiledHeaderOverride;
Result.bBuildLocallyWithSNDBS = Rules.bBuildLocallyWithSNDBS;
Result.bEnableExceptions |= Rules.bEnableExceptions;
Result.bEnableObjCExceptions |= Rules.bEnableObjCExceptions;
Result.bEnableShadowVariableWarnings = Rules.bEnableShadowVariableWarnings;
Result.bEnableUndefinedIdentifierWarnings = Rules.bEnableUndefinedIdentifierWarnings;
// If the module overrides the C++ language version, override it on the compile environment
if(Rules.CppStandard != CppStandardVersion.Default)
{
Result.CppStandard = Rules.CppStandard;
}
// Set the macro used to check whether monolithic headers can be used
if (Rules.bTreatAsEngineModule && (!Rules.bEnforceIWYU || !Target.bEnforceIWYU))
{
Result.Definitions.Add("SUPPRESS_MONOLITHIC_HEADER_WARNINGS=1");
}
// Add a macro for when we're compiling an engine module, to enable additional compiler diagnostics through code.
if (Rules.bTreatAsEngineModule)
{
Result.Definitions.Add("UE_IS_ENGINE_MODULE=1");
}
else
{
Result.Definitions.Add("UE_IS_ENGINE_MODULE=0");
}
// For game modules, set the define for the project name. This will be used by the IMPLEMENT_PRIMARY_GAME_MODULE macro.
if (!Rules.bTreatAsEngineModule)
{
// Make sure we don't set any define for a non-engine module that's under the engine directory (eg. UE4Game)
if (Target.ProjectFile != null && RulesFile.IsUnderDirectory(Target.ProjectFile.Directory))
{
string ProjectName = Target.ProjectFile.GetFileNameWithoutExtension();
Result.Definitions.Add(String.Format("UE_PROJECT_NAME={0}", ProjectName));
}
}
// Add the module's public and private definitions.
Result.Definitions.AddRange(PublicDefinitions);
Result.Definitions.AddRange(Rules.PrivateDefinitions);
// Add the project definitions
if(!Rules.bTreatAsEngineModule)
{
Result.Definitions.AddRange(Rules.Target.ProjectDefinitions);
}
// @ATG_CHANGE : BEGIN winmd support
// Add winmd files
Result.WinMDReferences.AddRange(Rules.PrivateWinMDReferences);
// Enable WinRT if requested, or auto-enable if WinMDs have been added to the environment
Result.bEnableWinRTComponentExtensions = Rules.bEnableWinRTComponentExtensions || Result.WinMDReferences.Count > 0;
// /ZW ends up generating #import directives, which must be compiled locally
Result.bBuildLocallyWithSNDBS = Result.bBuildLocallyWithSNDBS || Result.bEnableWinRTComponentExtensions;
// Setup the compile environment for the module.
SetupPrivateCompileEnvironment(Result.UserIncludePaths, Result.SystemIncludePaths, Result.Definitions, Result.AdditionalFrameworks, (Rules != null)? Rules.bLegacyPublicIncludePaths.Value : true, Result.WinMDReferences);
// @ATG_CHANGE : END winmd support
return Result;
}
///
/// Creates a compile environment for a shared PCH from a base environment based on the module settings.
///
/// The target being built
/// An existing environment to base the module compile environment on.
/// The new shared PCH compile environment.
public CppCompileEnvironment CreateSharedPCHCompileEnvironment(UEBuildTarget Target, CppCompileEnvironment BaseCompileEnvironment)
{
CppCompileEnvironment CompileEnvironment = new CppCompileEnvironment(BaseCompileEnvironment);
// Use the default optimization setting for
CompileEnvironment.bOptimizeCode = ShouldEnableOptimization(ModuleRules.CodeOptimization.Default, Target.Configuration, Rules.bTreatAsEngineModule);
// @ATG_CHANGE : BEGIN winmd support
List WinMDFiles = new List(BaseCompileEnvironment.WinMDReferences);
WinMDFiles.AddRange(PrivateWinMDReferences);
// @ATG_CHANGE : END winmd support
// Override compile environment
CompileEnvironment.bIsBuildingDLL = !Target.ShouldCompileMonolithic();
CompileEnvironment.bIsBuildingLibrary = false;
// Add a macro for when we're compiling an engine module, to enable additional compiler diagnostics through code.
if (Rules.bTreatAsEngineModule)
{
CompileEnvironment.Definitions.Add("UE_IS_ENGINE_MODULE=1");
}
else
{
CompileEnvironment.Definitions.Add("UE_IS_ENGINE_MODULE=0");
}
// Add the module's private definitions.
CompileEnvironment.Definitions.AddRange(PublicDefinitions);
// Find all the modules that are part of the public compile environment for this module.
Dictionary ModuleToIncludePathsOnlyFlag = new Dictionary();
FindModulesInPublicCompileEnvironment(ModuleToIncludePathsOnlyFlag);
// Now set up the compile environment for the modules in the original order that we encountered them
foreach (UEBuildModule Module in ModuleToIncludePathsOnlyFlag.Keys)
{
// @ATG_CHANGE : BEGIN - winmd support
Module.AddModuleToCompileEnvironment(null, CompileEnvironment.UserIncludePaths, CompileEnvironment.SystemIncludePaths, CompileEnvironment.Definitions, CompileEnvironment.AdditionalFrameworks, (Rules != null)? Rules.bLegacyPublicIncludePaths.Value : true, WinMDFiles);
// @ATG_CHANGE : END - winmd support
}
return CompileEnvironment;
}
public override void GetAllDependencyModules(List ReferencedModules, HashSet IgnoreReferencedModules, bool bIncludeDynamicallyLoaded, bool bForceCircular, bool bOnlyDirectDependencies)
{
List AllDependencyModules = new List();
AllDependencyModules.AddRange(PrivateDependencyModules);
AllDependencyModules.AddRange(PublicDependencyModules);
if (bIncludeDynamicallyLoaded)
{
AllDependencyModules.AddRange(DynamicallyLoadedModules);
}
foreach (UEBuildModule DependencyModule in AllDependencyModules)
{
if (!IgnoreReferencedModules.Contains(DependencyModule))
{
// Don't follow circular back-references!
bool bIsCircular = HasCircularDependencyOn(DependencyModule.Name);
if (bForceCircular || !bIsCircular)
{
IgnoreReferencedModules.Add(DependencyModule);
if (!bOnlyDirectDependencies)
{
// Recurse into dependent modules first
DependencyModule.GetAllDependencyModules(ReferencedModules, IgnoreReferencedModules, bIncludeDynamicallyLoaded, bForceCircular, bOnlyDirectDependencies);
}
ReferencedModules.Add(DependencyModule);
}
}
}
}
///
/// Finds all the source files that should be built for this module
///
/// The platform the module is being built for
/// Makefile for the target being built
/// Set of source files that should be built
InputFileCollection FindInputFiles(UnrealTargetPlatform Platform, TargetMakefile Makefile)
{
ReadOnlyHashSet ExcludedNames = UEBuildPlatform.GetBuildPlatform(Platform).GetExcludedFolderNames();
InputFileCollection InputFiles = new InputFileCollection();
SourceDirectories = new HashSet();
foreach (DirectoryReference Dir in ModuleDirectories)
{
DirectoryItem ModuleDirectoryItem = DirectoryItem.GetItemByDirectoryReference(Dir);
FindInputFilesFromDirectoryRecursive(ModuleDirectoryItem, ExcludedNames, SourceDirectories, Makefile.DirectoryToSourceFiles, InputFiles);
Makefile.SourceDirectories.Add(ModuleDirectoryItem);
}
return InputFiles;
}
///
/// Finds all the source files that should be built for this module
///
/// Directory to search from
/// Set of excluded directory names (eg. other platforms)
/// Set of all non-empty source directories.
/// Map from directory to source files inside it
/// Collection of source files, categorized by type
static void FindInputFilesFromDirectoryRecursive(DirectoryItem BaseDirectory, ReadOnlyHashSet ExcludedNames, HashSet SourceDirectories, Dictionary DirectoryToSourceFiles, InputFileCollection InputFiles)
{
foreach(DirectoryItem SubDirectory in BaseDirectory.EnumerateDirectories())
{
if(!ExcludedNames.Contains(SubDirectory.Name))
{
FindInputFilesFromDirectoryRecursive(SubDirectory, ExcludedNames, SourceDirectories, DirectoryToSourceFiles, InputFiles);
}
}
FileItem[] SourceFiles = FindInputFilesFromDirectory(BaseDirectory, InputFiles);
if(SourceFiles.Length > 0)
{
SourceDirectories.Add(BaseDirectory.Location);
}
DirectoryToSourceFiles.Add(BaseDirectory, SourceFiles);
}
///
/// Finds the input files that should be built for this module, from a given directory
///
///
///
/// Array of source files
static FileItem[] FindInputFilesFromDirectory(DirectoryItem BaseDirectory, InputFileCollection InputFiles)
{
List SourceFiles = new List();
foreach(FileItem InputFile in BaseDirectory.EnumerateFiles())
{
if (InputFile.HasExtension(".h"))
{
InputFiles.HeaderFiles.Add(InputFile);
}
if (InputFile.HasExtension(".cpp"))
{
SourceFiles.Add(InputFile);
InputFiles.CPPFiles.Add(InputFile);
}
else if (InputFile.HasExtension(".c"))
{
SourceFiles.Add(InputFile);
InputFiles.CFiles.Add(InputFile);
}
else if (InputFile.HasExtension(".cc"))
{
SourceFiles.Add(InputFile);
InputFiles.CCFiles.Add(InputFile);
}
else if (InputFile.HasExtension(".m") || InputFile.HasExtension(".mm"))
{
SourceFiles.Add(InputFile);
InputFiles.MMFiles.Add(InputFile);
}
else if (InputFile.HasExtension(".rc"))
{
SourceFiles.Add(InputFile);
InputFiles.RCFiles.Add(InputFile);
}
else if (InputFile.HasExtension(".ispc"))
{
SourceFiles.Add(InputFile);
InputFiles.ISPCFiles.Add(InputFile);
}
}
return SourceFiles.ToArray();
}
///
/// Gets a set of source files for the given directory. Used to detect when the makefile is out of date.
///
///
/// Array of source files
public static FileItem[] GetSourceFiles(DirectoryItem Directory)
{
return FindInputFilesFromDirectory(Directory, new InputFileCollection());
}
}
}