You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
4ba423868f
#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]
122 lines
4.4 KiB
C++
122 lines
4.4 KiB
C++
// Copyright 1998-2016 Epic Games, Inc. All Rights Reserved.
|
|
|
|
#include "CoreMinimal.h"
|
|
#include "ScriptGeneratorLog.h"
|
|
#include "ScriptCodeGeneratorBase.h"
|
|
#include "GenericScriptCodeGenerator.h"
|
|
#include "LuaScriptCodeGenerator.h"
|
|
#include "IProjectManager.h"
|
|
#include "Runtime/Core/Public/Features/IModularFeatures.h"
|
|
#include "UniquePtr.h"
|
|
|
|
DEFINE_LOG_CATEGORY(LogScriptGenerator);
|
|
|
|
class FScriptGeneratorPlugin : public IScriptGeneratorPlugin
|
|
{
|
|
/** Specialized script code generator */
|
|
TUniquePtr<FScriptCodeGeneratorBase> CodeGenerator;
|
|
|
|
/** IModuleInterface implementation */
|
|
virtual void StartupModule() override;
|
|
virtual void ShutdownModule() override;
|
|
|
|
/** IScriptGeneratorPlugin interface */
|
|
virtual FString GetGeneratedCodeModuleName() const override { return TEXT("ScriptPlugin"); }
|
|
virtual bool ShouldExportClassesForModule(const FString& ModuleName, EBuildModuleType::Type ModuleType, const FString& ModuleGeneratedIncludeDirectory) const override;
|
|
virtual bool SupportsTarget(const FString& TargetName) const override;
|
|
virtual void Initialize(const FString& RootLocalPath, const FString& RootBuildPath, const FString& OutputDirectory, const FString& IncludeBase) override;
|
|
virtual void ExportClass(UClass* Class, const FString& SourceHeaderFilename, const FString& GeneratedHeaderFilename, bool bHasChanged) override;
|
|
virtual void FinishExport() override;
|
|
virtual FString GetGeneratorName() const override;
|
|
};
|
|
|
|
IMPLEMENT_MODULE( FScriptGeneratorPlugin, ScriptGeneratorPlugin )
|
|
|
|
|
|
void FScriptGeneratorPlugin::StartupModule()
|
|
{
|
|
// Register ourselves as an editor feature
|
|
IModularFeatures::Get().RegisterModularFeature(TEXT("ScriptGenerator"), this);
|
|
}
|
|
|
|
void FScriptGeneratorPlugin::ShutdownModule()
|
|
{
|
|
CodeGenerator.Reset();
|
|
|
|
// Unregister our feature
|
|
IModularFeatures::Get().UnregisterModularFeature(TEXT("ScriptGenerator"), this);
|
|
}
|
|
|
|
FString FScriptGeneratorPlugin::GetGeneratorName() const
|
|
{
|
|
#if WITH_LUA
|
|
return TEXT("Lua Example Code Generator Plugin");
|
|
#else
|
|
return TEXT("Example Code Generator Plugin");
|
|
#endif
|
|
}
|
|
|
|
void FScriptGeneratorPlugin::Initialize(const FString& RootLocalPath, const FString& RootBuildPath, const FString& OutputDirectory, const FString& IncludeBase)
|
|
{
|
|
#if WITH_LUA
|
|
UE_LOG(LogScriptGenerator, Log, TEXT("Using Lua Script Generator."));
|
|
CodeGenerator = MakeUnique<FLuaScriptCodeGenerator>(RootLocalPath, RootBuildPath, OutputDirectory, IncludeBase);
|
|
#else
|
|
UE_LOG(LogScriptGenerator, Log, TEXT("Using Generic Script Generator."));
|
|
CodeGenerator = MakeUnique<FGenericScriptCodeGenerator>(RootLocalPath, RootBuildPath, OutputDirectory, IncludeBase);
|
|
#endif
|
|
UE_LOG(LogScriptGenerator, Log, TEXT("Output directory: %s"), *OutputDirectory);
|
|
}
|
|
|
|
bool FScriptGeneratorPlugin::ShouldExportClassesForModule(const FString& ModuleName, EBuildModuleType::Type ModuleType, const FString& ModuleGeneratedIncludeDirectory) const
|
|
{
|
|
bool bCanExport = (ModuleType == EBuildModuleType::EngineRuntime || ModuleType == EBuildModuleType::GameRuntime);
|
|
if (bCanExport)
|
|
{
|
|
// Only export functions from selected modules
|
|
static struct FSupportedModules
|
|
{
|
|
TArray<FString> SupportedScriptModules;
|
|
FSupportedModules()
|
|
{
|
|
GConfig->GetArray(TEXT("Plugins"), TEXT("ScriptSupportedModules"), SupportedScriptModules, GEngineIni);
|
|
}
|
|
} SupportedModules;
|
|
bCanExport = SupportedModules.SupportedScriptModules.Num() == 0 || SupportedModules.SupportedScriptModules.Contains(ModuleName);
|
|
}
|
|
return bCanExport;
|
|
}
|
|
|
|
void FScriptGeneratorPlugin::ExportClass(UClass* Class, const FString& SourceHeaderFilename, const FString& GeneratedHeaderFilename, bool bHasChanged)
|
|
{
|
|
CodeGenerator->ExportClass(Class, SourceHeaderFilename, GeneratedHeaderFilename, bHasChanged);
|
|
}
|
|
|
|
void FScriptGeneratorPlugin::FinishExport()
|
|
{
|
|
CodeGenerator->FinishExport();
|
|
}
|
|
|
|
bool FScriptGeneratorPlugin::SupportsTarget(const FString& TargetName) const
|
|
{
|
|
// We only support the target if it explicitly enables the required script plugin in its uproject file
|
|
bool bSupportsTarget = false;
|
|
if (FPaths::IsProjectFilePathSet())
|
|
{
|
|
FProjectDescriptor ProjectDescriptor;
|
|
FText OutError;
|
|
if (ProjectDescriptor.Load(FPaths::GetProjectFilePath(), OutError))
|
|
{
|
|
for (auto& PluginDescriptor : ProjectDescriptor.Plugins)
|
|
{
|
|
// For your own script plugin you might want to change the hardcoded name here to something else
|
|
if (PluginDescriptor.bEnabled && PluginDescriptor.Name == TEXT("ScriptPlugin"))
|
|
{
|
|
bSupportsTarget = true;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return bSupportsTarget;
|
|
} |