You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
70f725980e
checking out or writing any localization files. This makes dry runs to print all localization warnings much easier for debugging. - Introduced the -Preview arg and -GatherType param to UGatherTextCommandlet. - The -GatherType param can have values of All, Source, Asset or Metadata. Source will only gather source files, Asset will only gather Asset files, Metadata will only gather Metadata and All will gather all 3. - The -GatherType param is only supported in preview mode right now. This is because manifests are updated every single gather and we don't want the manifest to only reflect partial gathers. - Added additional logs to display when the commandlet is run with -Preview and -GatherType - Refactored parts of UGatherTextCommandlet to reduce hard coded switch and param names. - Introduced a virtual function in UGatherTextCommandletBase to allow commandlets to conditionally be skipped in preview mode. #rb: Jamie.Dale, Vincent.Gauthier #jira: UE-143692 #preflight: 62430e4a292f228e09e1e1f8 [CL 19550589 by Leon Huang in ue5-main branch]
113 lines
3.8 KiB
C++
113 lines
3.8 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "CoreMinimal.h"
|
|
#include "UObject/ObjectMacros.h"
|
|
#include "Commandlets/Commandlet.h"
|
|
#include "LocTextHelper.h"
|
|
#include "LocalizationSourceControlUtil.h"
|
|
#include "LocalizedAssetUtil.h"
|
|
#include "GatherTextCommandletBase.generated.h"
|
|
|
|
struct UNREALED_API FGatherTextDelegates
|
|
{
|
|
/** Delegate called during a localization gather to allow code to inject new gather and exclude paths for the given localization target */
|
|
DECLARE_MULTICAST_DELEGATE_ThreeParams(FGetAdditionalGatherPaths, const FString& /*InLocalizationTargetName*/, TArray<FString>& /*InOutIncludePathFilters*/, TArray<FString>& /*InOutExcludePathFilters*/);
|
|
static FGetAdditionalGatherPaths GetAdditionalGatherPaths;
|
|
};
|
|
|
|
/** Performs fuzzy path matching against a set of include and exclude paths */
|
|
class FFuzzyPathMatcher
|
|
{
|
|
public:
|
|
enum EPathMatch
|
|
{
|
|
Included,
|
|
Excluded,
|
|
NoMatch,
|
|
};
|
|
|
|
public:
|
|
FFuzzyPathMatcher(const TArray<FString>& InIncludePathFilters, const TArray<FString>& InExcludePathFilters);
|
|
|
|
EPathMatch TestPath(const FString& InPathToTest) const;
|
|
|
|
private:
|
|
enum EPathType : uint8
|
|
{
|
|
Include,
|
|
Exclude,
|
|
};
|
|
|
|
struct FFuzzyPath
|
|
{
|
|
FFuzzyPath(FString InPathFilter, const EPathType InPathType)
|
|
: PathFilter(MoveTemp(InPathFilter))
|
|
, PathType(InPathType)
|
|
{
|
|
}
|
|
|
|
FString PathFilter;
|
|
EPathType PathType;
|
|
};
|
|
|
|
TArray<FFuzzyPath> FuzzyPaths;
|
|
};
|
|
|
|
/**
|
|
* UGatherTextCommandletBase: Base class for localization commandlets. Just to force certain behaviors and provide helper functionality.
|
|
*/
|
|
UCLASS()
|
|
class UNREALED_API UGatherTextCommandletBase : public UCommandlet
|
|
{
|
|
GENERATED_UCLASS_BODY()
|
|
|
|
public:
|
|
virtual void Initialize( const TSharedRef< FLocTextHelper >& InGatherManifestHelper, const TSharedPtr< FLocalizationSCC >& InSourceControlInfo );
|
|
virtual void BeginDestroy() override;
|
|
|
|
// Wrappers for extracting config values
|
|
bool GetBoolFromConfig( const TCHAR* Section, const TCHAR* Key, bool& OutValue, const FString& Filename );
|
|
bool GetStringFromConfig( const TCHAR* Section, const TCHAR* Key, FString& OutValue, const FString& Filename );
|
|
bool GetPathFromConfig( const TCHAR* Section, const TCHAR* Key, FString& OutValue, const FString& Filename );
|
|
int32 GetStringArrayFromConfig( const TCHAR* Section, const TCHAR* Key, TArray<FString>& OutArr, const FString& Filename );
|
|
int32 GetPathArrayFromConfig( const TCHAR* Section, const TCHAR* Key, TArray<FString>& OutArr, const FString& Filename );
|
|
|
|
// Utilities for split platform detection
|
|
bool IsSplitPlatformName(const FName InPlatformName) const;
|
|
bool ShouldSplitPlatformForPath(const FString& InPath, FName* OutPlatformName = nullptr) const;
|
|
FName GetSplitPlatformNameFromPath(const FString& InPath) const;
|
|
|
|
// Utility to get the correct base path (engine or project) for the current environment
|
|
static const FString& GetProjectBasePath();
|
|
|
|
/**
|
|
* Returns true if this commandlet should run during a preview run.
|
|
* Override in child classes to conditionally skip a commandlet from being run.
|
|
* Most commandlets that require source control, write to files etc should be skipped for preview runs
|
|
*/
|
|
virtual bool ShouldRunInPreview(const TArray<FString>& Switches, const TMap<FString, FString>& ParamVals) const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
protected:
|
|
TSharedPtr< FLocTextHelper > GatherManifestHelper;
|
|
|
|
TSharedPtr< FLocalizationSCC > SourceControlInfo;
|
|
|
|
/** Mapping from platform name to the path marker for that platform */
|
|
TMap<FName, FString> SplitPlatforms;
|
|
|
|
// Common params and switches among all text gathering commadnlets
|
|
static const TCHAR* ConfigParam;
|
|
static const TCHAR* EnableSourceControlSwitch;
|
|
static const TCHAR* DisableSubmitSwitch;
|
|
static const TCHAR* PreviewSwitch;
|
|
static const TCHAR* GatherTypeParam;
|
|
|
|
private:
|
|
virtual void CreateCustomEngine(const FString& Params) override ; //Disallow other text commandlets to make their own engine.
|
|
};
|