CommandLine.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/Array.h"
#include "Containers/StringView.h"
#include "Containers/UnrealString.h"
 
/*-----------------------------------------------------------------------------
    Command line.
-----------------------------------------------------------------------------*/
 
#ifndef UE_COMMAND_LINE_USES_ALLOW_LIST
    #ifdef WANTS_COMMANDLINE_WHITELIST
        #pragma message("Use UE_COMMAND_LINE_USES_ALLOW_LIST instead of WANTS_COMMANDLINE_WHITELIST")
        #define UE_COMMAND_LINE_USES_ALLOW_LIST WANTS_COMMANDLINE_WHITELIST
    #else
        #define UE_COMMAND_LINE_USES_ALLOW_LIST 0
    #endif
#endif
 
 
enum class ECommandLineArgumentFlags
{
    None = 0x0000,
 
    //~ Application context for a commandline argument
    EditorContext = 0x0001,
    ClientContext = 0x0002,
    ServerContext = 0x0004,
    CommandletContext = 0x0008,
    ProgramContext = 0x0010,
 
    GameContexts = 0x0006,
    AllContexts = 0x001F,
 
    // Indicates this argument should be automatically inherited by subprocesses.
    // To be combined with one or more application context to inherit to.
    Inherit = 0x0020,
};
 
ENUM_CLASS_FLAGS(ECommandLineArgumentFlags)
 
struct FCommandLine
{
    static constexpr inline uint32 MaxCommandLineSize = 16384;
 
    CORE_API static void Reset();
 
    CORE_API static const TCHAR* Get();
    
    CORE_API static const TCHAR* GetForLogging();
 
    CORE_API static const TCHAR* GetOriginal();
 
    CORE_API static const TCHAR* GetOriginalForLogging();
 
    CORE_API static bool IsInitialized();
 
    CORE_API static uint32 GetCommandLineVersion();
 
    CORE_API static bool Set(const TCHAR* NewCommandLine);
 
    CORE_API static void Append(const TCHAR* AppendString);
 
    CORE_API static void RegisterArgument(FStringView Name, ECommandLineArgumentFlags Flags, FStringView Description = FStringView());
 
    UE_DEPRECATED(5.6, "Use AddToSubprocessCommandLine version with capital L and flags argument.")
    CORE_API static void AddToSubprocessCommandline( const TCHAR* Param );
 
    CORE_API static void AddToSubprocessCommandLine( const TCHAR* Param, ECommandLineArgumentFlags ApplicationContextFlags );
 
    UE_DEPRECATED(5.6, "Use BuildSubprocessCommandLine instead.")
    CORE_API static const FString& GetSubprocessCommandline();
 
    CORE_API static void BuildSubprocessCommandLine(ECommandLineArgumentFlags ApplicationContextFlags, bool bOnlyInherited, FStringBuilderBase& OutCommandline);
 
    CORE_API static const TCHAR* RemoveExeName(const TCHAR* CmdLine);
 
    CORE_API static void Parse(const TCHAR* CmdLine, TArray<FString>& Tokens, TArray<FString>& Switches);
 
    CORE_API static bool IsCommandLineLoggingFiltered();
 
    CORE_API static FString BuildFromArgV(const WIDECHAR* Prefix, int32 ArgC, WIDECHAR* ArgV[], const WIDECHAR* Suffix);
    CORE_API static FString BuildFromArgV(const ANSICHAR* Prefix, int32 ArgC, ANSICHAR* ArgV[], const ANSICHAR* Suffix);
 
    static bool FilterCLIUsingGrammarBasedParser(TCHAR* OutLine, int32 MaxLen, const TCHAR* InLine, const TArrayView<FString>& AllowedList);
private:
#if UE_COMMAND_LINE_USES_ALLOW_LIST
    static void ApplyCommandLineAllowList();
    static TArray<FString> FilterCommandLine(TCHAR* CommandLine);
    static TArray<FString> FilterCommandLineForLogging(TCHAR* CommandLine);
    static void BuildCommandLineAllowList(TCHAR* CommandLine, uint32 Length, const TArray<FString>& FilteredArgs);
    static TArray<FString> ApprovedArgs;
    static TArray<FString> FilterArgsForLogging;
#else
    #define ApplyCommandLineAllowList()
#endif
 
    static bool bIsInitialized;
    static TCHAR CmdLine[MaxCommandLineSize];
    static TCHAR OriginalCmdLine[MaxCommandLineSize];
    static TCHAR LoggingCmdLine[MaxCommandLineSize];
    static TCHAR LoggingOriginalCmdLine[MaxCommandLineSize];
    static FString& GetSubprocessCommandLine_Internal(ECommandLineArgumentFlags ContextFlags);
    static void AddToSubprocessCommandLine_Internal(const TCHAR* Param, ECommandLineArgumentFlags ApplicationContextFlags);
    static uint32 CmdLineVersion;
 
    struct FRegisteredArgData
    {
        ECommandLineArgumentFlags Flags = ECommandLineArgumentFlags::None;
        FString Description;
    };
    static TMap<FString, FRegisteredArgData> RegisteredArgs;
};