2016-12-08 08:52:44 -05:00
// Copyright 1998-2017 Epic Games, Inc. All Rights Reserved.
2016-06-29 18:00:01 -04:00
# include "MergeManifestMode.h"
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340)
#lockdown Nick.Penwarden
#rb none
==========================
MAJOR FEATURES + CHANGES
==========================
Change 3209340 on 2016/11/23 by Ben.Marsh
Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h.
Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms.
* Every header now includes everything it needs to compile.
* There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first.
* There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h.
* Every .cpp file includes its matching .h file first.
* This helps validate that each header is including everything it needs to compile.
* No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more.
* You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there.
* There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible.
* No engine code explicitly includes a precompiled header any more.
* We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies.
* PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files.
Tool used to generate this transform is at Engine\Source\Programs\IncludeTool.
[CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
# include "Interfaces/IBuildPatchServicesModule.h"
# include "BuildPatchTool.h"
# include "Misc/CommandLine.h"
# include "Misc/Paths.h"
2016-06-29 18:00:01 -04:00
using namespace BuildPatchTool ;
class FMergeManifestToolMode : public IToolMode
{
public :
FMergeManifestToolMode ( const TSharedRef < IBuildPatchServicesModule > & InBpsInterface )
: BpsInterface ( InBpsInterface )
{ }
virtual ~ FMergeManifestToolMode ( )
{ }
virtual EReturnCode Execute ( ) override
{
// Parse commandline
if ( ProcessCommandline ( ) = = false )
{
return EReturnCode : : ArgumentProcessingError ;
}
// Print help if requested
if ( bHelp )
{
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " MERGE MANIFEST MODE " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " This tool supports generating a hotfix manifest from two existing manifest files. " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " Required arguments: " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " -mode=MergeManifests Must be specified to launch the tool in merge manifests mode. " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " -ManifestA= \" \" Specifies in quotes the file path to the base manifest. " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " -ManifestB= \" \" Specifies in quotes the file path to the update manifest. " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " -ManifestC= \" \" Specifies in quotes the file path to the output manifest. " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " -BuildVersion= \" \" Specifies in quotes the new version string for the build being produced. " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " Optional arguments: " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " -MergeFileList= \" \" Specifies in quotes, the path to a text file containing complete list of desired build root relative files followed by \\ t character, followed by A or B to select the manifest to pull from. These should be seperated by \\ r \\ n line endings. " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " NB: If -MergeFileList is not specified, then union of all files will be selected, preferring ManifestB's version. " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " NB: With the exception of the new version string for the build, all meta will be copied from only ManifestB. " ) ) ;
UE_LOG ( LogBuildPatchTool , Log , TEXT ( " " ) ) ;
return EReturnCode : : OK ;
}
// Run the merge manifest routine
bool bSuccess = BpsInterface - > MergeManifests ( ManifestA , ManifestB , ManifestC , BuildVersion , MergeFileList ) ;
return bSuccess ? EReturnCode : : OK : EReturnCode : : ToolFailure ;
}
private :
bool ProcessCommandline ( )
{
# define PARSE_SWITCH(Switch) ParseSwitch(TEXT(#Switch L"="), Switch, Switches)
TArray < FString > Tokens , Switches ;
FCommandLine : : Parse ( FCommandLine : : Get ( ) , Tokens , Switches ) ;
bHelp = ParseOption ( TEXT ( " help " ) , Switches ) ;
if ( bHelp )
{
return true ;
}
// Get all required parameters
if ( ! ( PARSE_SWITCH ( ManifestA )
& & PARSE_SWITCH ( ManifestB )
& & PARSE_SWITCH ( ManifestC )
& & PARSE_SWITCH ( BuildVersion ) ) )
{
UE_LOG ( LogBuildPatchTool , Error , TEXT ( " ManifestA, ManifestB, ManifestC, and BuildVersion are required parameters " ) ) ;
return false ;
}
FPaths : : NormalizeDirectoryName ( ManifestA ) ;
FPaths : : NormalizeDirectoryName ( ManifestB ) ;
FPaths : : NormalizeDirectoryName ( ManifestC ) ;
// Optional list to pick specific files, otherwise it is A stomped by B
PARSE_SWITCH ( MergeFileList ) ;
FPaths : : NormalizeDirectoryName ( MergeFileList ) ;
return true ;
# undef PARSE_SWITCH
}
private :
TSharedRef < IBuildPatchServicesModule > BpsInterface ;
bool bHelp ;
FString ManifestA ;
FString ManifestB ;
FString ManifestC ;
FString BuildVersion ;
FString MergeFileList ;
} ;
BuildPatchTool : : IToolModeRef BuildPatchTool : : FMergeManifestToolModeFactory : : Create ( const TSharedRef < IBuildPatchServicesModule > & BpsInterface )
{
return MakeShareable ( new FMergeManifestToolMode ( BpsInterface ) ) ;
}