You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
6fc0764c07
#rb PJ.Kack #jira UE-147055 #preflight 623c401ec3399da9533f1b29 ### Features - Designed to be a custom tool in P4V although it can be called manually. - The submit works just like the in editor package submission process. - If the changelist being submitted contains packages from multiple projects the tool can virtualize each project's packages in a separate pass. ### Limitations - Currently no way to auto install, this has to be compiled and set up manually - The tool is written in cpp and uses engine code, this is so we can share the in editor code for pushing payloads and work with any additional backend plugins that 3rd parties may have written. - If a changelist does not contain any packages, or the packages are in a project that does not support virtualization there will be a small amount of overhead while the tool works out that nothing needs to be done. [CL 19493529 by paul chipchase in ue5-main branch]
111 lines
3.0 KiB
C++
111 lines
3.0 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "Containers/Array.h"
|
|
#include "Containers/UnrealString.h"
|
|
#include "ISourceControlChangelist.h" // TODO
|
|
#include "Templates/UniquePtr.h"
|
|
|
|
class ISourceControlProvider;
|
|
|
|
struct FPlugin
|
|
{
|
|
FString PluginFilePath;
|
|
|
|
TArray<FString> PackagePaths;
|
|
};
|
|
|
|
struct FProject
|
|
{
|
|
FString ProjectFilePath;
|
|
|
|
TArray<FPlugin> Plugins;
|
|
TArray<FString> PackagePaths;
|
|
|
|
void AddFile(const FString& FilePath);
|
|
void AddPluginFile(const FString& FilePath, const FString& PluginFilePath);
|
|
|
|
FStringView GetProjectName() const;
|
|
TArray<FString> GetAllPackages() const;
|
|
|
|
void RegisterMountPoints() const;
|
|
void UnRegisterMountPoints() const;
|
|
|
|
bool TryLoadConfig(FConfigFile& OutConfig) const;
|
|
};
|
|
|
|
// Note that the enum doesn't give us huge value right now, it has been provided
|
|
// in case that we expand with additional functionality in the future.
|
|
|
|
/** A bitfield of the various operations that the virtualization process supports */
|
|
enum class EProcessOptions : uint32
|
|
{
|
|
/** No options */
|
|
None = 0,
|
|
/** Virtualize the packages in the provided changelist */
|
|
Virtualize = 1 << 0,
|
|
/** Submit the changelist */
|
|
Submit = 1 << 1
|
|
};
|
|
ENUM_CLASS_FLAGS(EProcessOptions);
|
|
|
|
/** The result of FUnrealVirtualizationToolApp initialization */
|
|
enum class EInitResult
|
|
{
|
|
/** Initialization succeeded and the application should run. */
|
|
Success = 0,
|
|
/** No error was encountered but the application should early out and not run. */
|
|
EarlyOut,
|
|
/** Initialization failed with an error, we should not run and should display an error to the user */
|
|
Error
|
|
};
|
|
|
|
class FUnrealVirtualizationToolApp
|
|
{
|
|
public:
|
|
FUnrealVirtualizationToolApp();
|
|
~FUnrealVirtualizationToolApp();
|
|
|
|
EInitResult Initialize();
|
|
bool Run();
|
|
|
|
private:
|
|
|
|
void PrintCmdLineHelp() const;
|
|
|
|
bool TrySubmitChangelist(const TArray<FString>& DescriptionTags);
|
|
|
|
bool TryLoadModules();
|
|
bool TryInitEnginePlugins();
|
|
EInitResult TryParseCmdLine();
|
|
bool TryParseChangelist(TArray<FString>& OutChangelistPackages);
|
|
bool TrySortFilesByProject(const TArray<FString>& ChangelistPackages);
|
|
bool TryFindProject(const FString& PackagePath, FString& ProjectFilePath, FString& PluginFilePath) const;
|
|
|
|
FProject& FindOrAddProject(const FString& ProjectFilePath);
|
|
|
|
private:
|
|
|
|
/** Override used to suppress log messages */
|
|
TUniquePtr<FFeedbackContext> OutputDeviceOverride;
|
|
|
|
/** The source control provider that the tool uses */
|
|
TUniquePtr<ISourceControlProvider> SCCProvider;
|
|
|
|
/** Pointer to the changelist that should be submitted */
|
|
FSourceControlChangelistPtr ChangelistToSubmit;
|
|
|
|
/** Data structure holding the files in the changelist sorted by project and then by plugin*/
|
|
TArray<FProject> Projects;
|
|
|
|
/** Name of the client spec (workspace) passed in on the command line*/
|
|
FString ClientSpecName;
|
|
|
|
/** The number of the changelist being submitted, passed in on the command line */
|
|
FString ChangelistNumber;
|
|
|
|
/** Bitfield control the various options that should be run */
|
|
EProcessOptions ProcessOptions = EProcessOptions::Virtualize;
|
|
};
|