You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
ab142f400f
#fyi leon.huang #preflight 62912405f6625a3541a0b1ea [CL 20400528 by Ben Marsh in ue5-main branch]
506 lines
14 KiB
C++
506 lines
14 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "CoreMinimal.h"
|
|
#include "UObject/ObjectMacros.h"
|
|
#include "Framework/Commands/Commands.h"
|
|
#include "Commandlets/GatherTextCommandletBase.h"
|
|
#include "Internationalization/StringTableCore.h"
|
|
#include "GatherTextFromSourceCommandlet.generated.h"
|
|
|
|
class Error;
|
|
|
|
enum class EGatherTextSourceFileTypes : uint8
|
|
{
|
|
None = 0,
|
|
Cpp = 1 << 0,
|
|
Ini = 1 << 1,
|
|
};
|
|
ENUM_CLASS_FLAGS(EGatherTextSourceFileTypes);
|
|
|
|
/**
|
|
* UGatherTextFromSourceCommandlet: Localization commandlet that collects all text to be localized from the source code.
|
|
*/
|
|
UCLASS()
|
|
class UGatherTextFromSourceCommandlet : public UGatherTextCommandletBase
|
|
{
|
|
GENERATED_UCLASS_BODY()
|
|
|
|
private:
|
|
#define LOC_DEFINE_REGION
|
|
|
|
enum class EEditorOnlyDefineState : uint8
|
|
{
|
|
Undefined,
|
|
Defined,
|
|
};
|
|
|
|
struct FSourceLocation
|
|
{
|
|
FSourceLocation()
|
|
: File()
|
|
, Line(INDEX_NONE)
|
|
{
|
|
}
|
|
|
|
FSourceLocation(FString InFile, const int32 InLine)
|
|
: File(MoveTemp(InFile))
|
|
, Line(InLine)
|
|
{
|
|
}
|
|
|
|
FString ToString() const
|
|
{
|
|
return (Line == INDEX_NONE) ? File : FString::Printf(TEXT("%s(%d)"), *File, Line);
|
|
}
|
|
|
|
FString File;
|
|
int32 Line;
|
|
};
|
|
|
|
struct FParsedStringTableEntry
|
|
{
|
|
FString SourceString;
|
|
FSourceLocation SourceLocation;
|
|
FName PlatformName;
|
|
bool bIsEditorOnly;
|
|
};
|
|
|
|
struct FParsedStringTableEntryMetaData
|
|
{
|
|
FString MetaData;
|
|
FSourceLocation SourceLocation;
|
|
bool bIsEditorOnly;
|
|
};
|
|
|
|
typedef TMap<FName, FParsedStringTableEntryMetaData> FParsedStringTableEntryMetaDataMap;
|
|
|
|
struct FParsedStringTable
|
|
{
|
|
FString TableNamespace;
|
|
FSourceLocation SourceLocation;
|
|
TMap<FString, FParsedStringTableEntry, FDefaultSetAllocator, FLocKeyMapFuncs<FParsedStringTableEntry>> TableEntries;
|
|
TMap<FString, FParsedStringTableEntryMetaDataMap, FDefaultSetAllocator, FLocKeyMapFuncs<FParsedStringTableEntryMetaDataMap>> MetaDataEntries;
|
|
};
|
|
|
|
class FMacroArgumentGatherer
|
|
{
|
|
public:
|
|
FMacroArgumentGatherer() {};
|
|
|
|
bool Gather(const TCHAR* Arg, int32 Count);
|
|
bool EndArgument();
|
|
|
|
// Return the number of argument that are completely resolved.
|
|
int32 GetNumberOfArguments() const;
|
|
|
|
void ExtractArguments(TArray<FString>& Arguments);
|
|
|
|
void OpenDoubleQuotes()
|
|
{
|
|
bInDblQuotes = true;
|
|
}
|
|
|
|
void CloseDoubleQuotes()
|
|
{
|
|
bInDblQuotes = false;
|
|
}
|
|
|
|
bool IsInDoubleQuotes() const
|
|
{
|
|
return bInDblQuotes;
|
|
};
|
|
|
|
void OpenSingleQuotes()
|
|
{
|
|
bInSglQuotes = true;
|
|
}
|
|
|
|
void CloseSingleQuotes()
|
|
{
|
|
bInSglQuotes = false;
|
|
}
|
|
|
|
bool IsInSingleQuotes() const
|
|
{
|
|
return bInSglQuotes;
|
|
};
|
|
|
|
private:
|
|
TArray<FString> Args;
|
|
FString CurrentArgument;
|
|
bool bInDblQuotes = false;
|
|
bool bInSglQuotes = false;
|
|
};
|
|
|
|
struct FSourceFileParseContext
|
|
{
|
|
bool AddManifestText( const FString& Token, const FString& Namespace, const FString& SourceText, const FManifestContext& Context );
|
|
|
|
void PushMacroBlock( const FString& InBlockCtx );
|
|
|
|
void PopMacroBlock();
|
|
|
|
void FlushMacroStack();
|
|
|
|
EEditorOnlyDefineState EvaluateEditorOnlyDefineState() const;
|
|
|
|
void SetDefine( const FString& InDefineCtx );
|
|
|
|
void RemoveDefine( const FString& InDefineCtx );
|
|
|
|
void AddStringTable( const FName InTableId, const FString& InTableNamespace );
|
|
|
|
void AddStringTableFromFile( const FName InTableId, const FString& InTableNamespace, const FString& InTableFilename, const FString& InRootPath );
|
|
|
|
void AddStringTableEntry( const FName InTableId, const FString& InKey, const FString& InSourceString );
|
|
|
|
void AddStringTableEntryMetaData( const FName InTableId, const FString& InKey, const FName InMetaDataId, const FString& InMetaData );
|
|
|
|
//Working data
|
|
EGatherTextSourceFileTypes FileTypes;
|
|
FString Filename;
|
|
int32 LineNumber;
|
|
FName FilePlatformName;
|
|
FString LineText;
|
|
FString Namespace;
|
|
FString RawStringLiteralClosingDelim;
|
|
bool ExcludedRegion;
|
|
bool EndParsingCurrentLine;
|
|
bool WithinBlockComment;
|
|
bool WithinLineComment;
|
|
bool WithinStringLiteral;
|
|
int32 WithinNamespaceDefineLineNumber;
|
|
const TCHAR* WithinStartingLine;
|
|
|
|
//Should editor-only data be included in this gather?
|
|
bool ShouldGatherFromEditorOnlyData;
|
|
|
|
//Discovered string table data from all files
|
|
TMap<FName, FParsedStringTable> ParsedStringTables;
|
|
|
|
TArray<FString> TextLines;
|
|
|
|
FSourceFileParseContext(UGatherTextFromSourceCommandlet* InOwnerCommandlet)
|
|
: FileTypes(EGatherTextSourceFileTypes::None)
|
|
, Filename()
|
|
, LineNumber(0)
|
|
, FilePlatformName()
|
|
, LineText()
|
|
, Namespace()
|
|
, ExcludedRegion(false)
|
|
, EndParsingCurrentLine(false)
|
|
, WithinBlockComment(false)
|
|
, WithinLineComment(false)
|
|
, WithinStringLiteral(false)
|
|
, WithinNamespaceDefineLineNumber(INDEX_NONE)
|
|
, WithinStartingLine(nullptr)
|
|
, ShouldGatherFromEditorOnlyData(false)
|
|
, MacroBlockStack()
|
|
, CachedEditorOnlyDefineState()
|
|
, OwnerCommandlet(InOwnerCommandlet)
|
|
{
|
|
check(OwnerCommandlet);
|
|
}
|
|
|
|
private:
|
|
bool AddStringTableImpl( const FName InTableId, const FString& InTableNamespace );
|
|
bool AddStringTableEntryImpl( const FName InTableId, const FString& InKey, const FString& InSourceString, const FSourceLocation& InSourceLocation, const FName InPlatformName );
|
|
bool AddStringTableEntryMetaDataImpl( const FName InTableId, const FString& InKey, const FName InMetaDataId, const FString& InMetaData, const FSourceLocation& InSourceLocation );
|
|
|
|
//Working data
|
|
TArray<FString> MacroBlockStack;
|
|
mutable TOptional<EEditorOnlyDefineState> CachedEditorOnlyDefineState;
|
|
|
|
UGatherTextFromSourceCommandlet* OwnerCommandlet;
|
|
};
|
|
|
|
class FParsableDescriptor
|
|
{
|
|
public:
|
|
virtual ~FParsableDescriptor() = default;
|
|
virtual const FString& GetToken() const = 0;
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const = 0;
|
|
|
|
bool MatchesFileTypes(const EGatherTextSourceFileTypes InFileTypes) { return EnumHasAnyFlags(ApplicableFileTypes, InFileTypes); }
|
|
bool OverridesLongerTokens() { return bOverridesLongerTokens; }
|
|
|
|
protected:
|
|
EGatherTextSourceFileTypes ApplicableFileTypes = EGatherTextSourceFileTypes::None;
|
|
bool bOverridesLongerTokens = false;
|
|
};
|
|
|
|
class FPreProcessorDescriptor : public FParsableDescriptor
|
|
{
|
|
public:
|
|
FPreProcessorDescriptor()
|
|
{
|
|
ApplicableFileTypes = EGatherTextSourceFileTypes::Cpp;
|
|
bOverridesLongerTokens = true;
|
|
}
|
|
|
|
protected:
|
|
static const FString DefineString;
|
|
static const FString UndefString;
|
|
static const FString IfString;
|
|
static const FString IfDefString;
|
|
static const FString ElIfString;
|
|
static const FString ElseString;
|
|
static const FString EndIfString;
|
|
static const FString DefinedString;
|
|
static const FString IniNamespaceString;
|
|
};
|
|
|
|
class FDefineDescriptor : public FPreProcessorDescriptor
|
|
{
|
|
public:
|
|
virtual const FString& GetToken() const override { return FPreProcessorDescriptor::DefineString; }
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
|
|
class FUndefDescriptor : public FPreProcessorDescriptor
|
|
{
|
|
public:
|
|
virtual const FString& GetToken() const override { return FPreProcessorDescriptor::UndefString; }
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
|
|
class FIfDescriptor : public FPreProcessorDescriptor
|
|
{
|
|
public:
|
|
virtual const FString& GetToken() const override { return FPreProcessorDescriptor::IfString; }
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
|
|
class FIfDefDescriptor : public FPreProcessorDescriptor
|
|
{
|
|
public:
|
|
virtual const FString& GetToken() const override { return FPreProcessorDescriptor::IfDefString; }
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
|
|
class FElIfDescriptor : public FPreProcessorDescriptor
|
|
{
|
|
public:
|
|
virtual const FString& GetToken() const override { return FPreProcessorDescriptor::ElIfString; }
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
|
|
class FElseDescriptor : public FPreProcessorDescriptor
|
|
{
|
|
public:
|
|
virtual const FString& GetToken() const override { return FPreProcessorDescriptor::ElseString; }
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
|
|
class FEndIfDescriptor : public FPreProcessorDescriptor
|
|
{
|
|
public:
|
|
virtual const FString& GetToken() const override { return FPreProcessorDescriptor::EndIfString; }
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
|
|
class FMacroDescriptor : public FParsableDescriptor
|
|
{
|
|
public:
|
|
static const FString TextMacroString;
|
|
|
|
FMacroDescriptor(FString InName, int32 InMinArgumentNumber)
|
|
: Name(MoveTemp(InName))
|
|
, MinArgumentNumber(InMinArgumentNumber)
|
|
{
|
|
ApplicableFileTypes = EGatherTextSourceFileTypes::Cpp;
|
|
}
|
|
|
|
virtual const FString& GetToken() const override
|
|
{
|
|
return Name;
|
|
}
|
|
|
|
int32 GetMinNumberOfArgument() const
|
|
{
|
|
return MinArgumentNumber;
|
|
}
|
|
|
|
protected:
|
|
bool ParseArgsFromMacro(const FString& Text, TArray<FString>& Args, FSourceFileParseContext& Context) const;
|
|
bool ParseArgsFromNextLines(FMacroArgumentGatherer& ArgsGatherer, int32& BracketStack, FSourceFileParseContext& Context) const;
|
|
bool ParseArgumentString(const FString& Text, const int32 OpenBracketIdx, int32& BracketStack, const FSourceFileParseContext& Context, FMacroArgumentGatherer& ArgsGatherer) const;
|
|
|
|
static bool PrepareArgument(FString& Argument, bool IsAutoText, const FString& IdentForLogging, bool& OutHasQuotes);
|
|
|
|
private:
|
|
const FString Name;
|
|
|
|
// Minimum number argument for that Macro.
|
|
const int32 MinArgumentNumber;
|
|
};
|
|
|
|
class FUICommandMacroDescriptor : public FMacroDescriptor
|
|
{
|
|
public:
|
|
FUICommandMacroDescriptor()
|
|
: FMacroDescriptor(TEXT("UI_COMMAND"), 5)
|
|
{
|
|
}
|
|
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
|
|
protected:
|
|
FUICommandMacroDescriptor(FString InName, int32 InMinNumberOfArgument)
|
|
: FMacroDescriptor(MoveTemp(InName), InMinNumberOfArgument)
|
|
{
|
|
}
|
|
|
|
void TryParseArgs(const FString& Text, FSourceFileParseContext& Context, const TArray<FString>& Arguments, const int32 ArgIndexOffset) const;
|
|
};
|
|
|
|
class FUICommandExtMacroDescriptor : public FUICommandMacroDescriptor
|
|
{
|
|
public:
|
|
FUICommandExtMacroDescriptor()
|
|
: FUICommandMacroDescriptor(TEXT("UI_COMMAND_EXT"), 5)
|
|
{
|
|
}
|
|
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
/** Macro descriptor to parse METASOUND_PARAM(NAME, NAME_TEXT, TOOLTIP_TEXT) macros. */
|
|
class FMetasoundParamMacroDescriptor : public FMacroDescriptor
|
|
{
|
|
public:
|
|
FMetasoundParamMacroDescriptor()
|
|
: FMacroDescriptor(TEXT("METASOUND_PARAM"), 3)
|
|
{
|
|
}
|
|
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
|
|
protected:
|
|
FMetasoundParamMacroDescriptor(FString InName, int32 InMinNumberOfArgument)
|
|
: FMacroDescriptor(MoveTemp(InName), InMinNumberOfArgument)
|
|
{
|
|
}
|
|
|
|
void TryParseArgs(const FString& Text, FSourceFileParseContext& Context, const TArray<FString>& Arguments, const int32 ArgIndexOffset) const;
|
|
};
|
|
|
|
class FStringMacroDescriptor : public FMacroDescriptor
|
|
{
|
|
public:
|
|
enum EMacroArgSemantic
|
|
{
|
|
MAS_Namespace,
|
|
MAS_Identifier,
|
|
MAS_SourceText,
|
|
};
|
|
|
|
struct FMacroArg
|
|
{
|
|
EMacroArgSemantic Semantic;
|
|
bool IsAutoText;
|
|
|
|
FMacroArg(EMacroArgSemantic InSema, bool InIsAutoText) : Semantic(InSema), IsAutoText(InIsAutoText) {}
|
|
};
|
|
|
|
FStringMacroDescriptor(FString InName, FMacroArg Arg0, FMacroArg Arg1, FMacroArg Arg2) : FMacroDescriptor(InName, 3)
|
|
{
|
|
ApplicableFileTypes = EGatherTextSourceFileTypes::Cpp | EGatherTextSourceFileTypes::Ini;
|
|
Arguments.Add(Arg0);
|
|
Arguments.Add(Arg1);
|
|
Arguments.Add(Arg2);
|
|
}
|
|
|
|
FStringMacroDescriptor(FString InName, FMacroArg Arg0, FMacroArg Arg1) : FMacroDescriptor(InName, 2)
|
|
{
|
|
ApplicableFileTypes = EGatherTextSourceFileTypes::Cpp | EGatherTextSourceFileTypes::Ini;
|
|
Arguments.Add(Arg0);
|
|
Arguments.Add(Arg1);
|
|
}
|
|
|
|
FStringMacroDescriptor(FString InName, FMacroArg Arg0) : FMacroDescriptor(InName, 1)
|
|
{
|
|
ApplicableFileTypes = EGatherTextSourceFileTypes::Cpp | EGatherTextSourceFileTypes::Ini;
|
|
Arguments.Add(Arg0);
|
|
}
|
|
|
|
virtual void TryParse(const FString& LineText, FSourceFileParseContext& Context) const override;
|
|
|
|
private:
|
|
TArray<FMacroArg> Arguments;
|
|
};
|
|
|
|
class FStringTableMacroDescriptor : public FMacroDescriptor
|
|
{
|
|
public:
|
|
FStringTableMacroDescriptor()
|
|
: FMacroDescriptor(TEXT("LOCTABLE_NEW"), 2)
|
|
{
|
|
}
|
|
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
|
|
class FStringTableFromFileMacroDescriptor : public FMacroDescriptor
|
|
{
|
|
public:
|
|
FStringTableFromFileMacroDescriptor(FString InName, FString InRootPath) : FMacroDescriptor(MoveTemp(InName), 3), RootPath(MoveTemp(InRootPath)) {}
|
|
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
|
|
private:
|
|
FString RootPath;
|
|
};
|
|
|
|
class FStringTableEntryMacroDescriptor : public FMacroDescriptor
|
|
{
|
|
public:
|
|
FStringTableEntryMacroDescriptor()
|
|
: FMacroDescriptor(TEXT("LOCTABLE_SETSTRING"), 3)
|
|
{
|
|
}
|
|
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
|
|
class FStringTableEntryMetaDataMacroDescriptor : public FMacroDescriptor
|
|
{
|
|
public:
|
|
FStringTableEntryMetaDataMacroDescriptor()
|
|
: FMacroDescriptor(TEXT("LOCTABLE_SETMETA"), 4)
|
|
{
|
|
}
|
|
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
|
|
class FIniNamespaceDescriptor : public FPreProcessorDescriptor
|
|
{
|
|
public:
|
|
FIniNamespaceDescriptor()
|
|
{
|
|
ApplicableFileTypes = EGatherTextSourceFileTypes::Ini;
|
|
}
|
|
|
|
virtual const FString& GetToken() const override { return FPreProcessorDescriptor::IniNamespaceString; }
|
|
virtual void TryParse(const FString& Text, FSourceFileParseContext& Context) const override;
|
|
};
|
|
|
|
static const FString ChangelistName;
|
|
|
|
static FString UnescapeLiteralCharacterEscapeSequences(const FString& InString);
|
|
static FString RemoveStringFromTextMacro(const FString& TextMacro, const FString& IdentForLogging, bool& Error);
|
|
static FString StripCommentsFromToken(const FString& InToken, FSourceFileParseContext& Context);
|
|
static bool ParseSourceText(const FString& Text, const TArray<FParsableDescriptor*>& Parsables, FSourceFileParseContext& ParseCtxt);
|
|
|
|
public:
|
|
//~ Begin UCommandlet Interface
|
|
virtual int32 Main(const FString& Params) override;
|
|
//~ End UCommandlet Interface
|
|
//~ Begin UGatherTextCommandletBase Interface
|
|
virtual bool ShouldRunInPreview(const TArray<FString>& Switches, const TMap<FString, FString>& ParamVals) const override;
|
|
//~ End UGatherTextCommandletBase Interface
|
|
#undef LOC_DEFINE_REGION
|
|
};
|