ConsoleManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "HAL/IConsoleManager.h"
 
class FConsoleManager : public IConsoleManager
{
public:
 
    FConsoleManager();
    ~FConsoleManager();
 
    virtual IConsoleVariable* RegisterConsoleVariable(const TCHAR* Name, bool DefaultValue, const TCHAR* Help, uint32 Flags) override;
    virtual IConsoleVariable* RegisterConsoleVariable(const TCHAR* Name, int32 DefaultValue, const TCHAR* Help, uint32 Flags) override;
    virtual IConsoleVariable* RegisterConsoleVariable(const TCHAR* Name, float DefaultValue, const TCHAR* Help, uint32 Flags) override;
    virtual IConsoleVariable* RegisterConsoleVariable(const TCHAR* Name, const TCHAR* DefaultValue, const TCHAR* Help, uint32 Flags) override;
    virtual IConsoleVariable* RegisterConsoleVariable(const TCHAR* Name, const FString& DefaultValue, const TCHAR* Help, uint32 Flags) override;
 
    virtual IConsoleVariable* RegisterConsoleVariableRef(const TCHAR* Name, bool& RefValue, const TCHAR* Help, uint32 Flags) override;
    virtual IConsoleVariable* RegisterConsoleVariableRef(const TCHAR* Name, int32& RefValue, const TCHAR* Help, uint32 Flags) override;
    virtual IConsoleVariable* RegisterConsoleVariableRef(const TCHAR* Name, float& RefValue, const TCHAR* Help, uint32 Flags) override;
    virtual IConsoleVariable* RegisterConsoleVariableRef(const TCHAR* Name, FString& RefValue, const TCHAR* Help, uint32 Flags) override;
    virtual IConsoleVariable* RegisterConsoleVariableRef(const TCHAR* Name, FName& RefValue, const TCHAR* Help, uint32 Flags) override;
    virtual IConsoleVariable* RegisterConsoleVariableBitRef(const TCHAR* CVarName, const TCHAR* FlagName, uint32 BitNumber, uint8* Force0MaskPtr, uint8* Force1MaskPtr, const TCHAR* Help, uint32 Flags) override;
 
    virtual IConsoleCommand* RegisterConsoleCommand(const TCHAR* Name, const TCHAR* Help, const FConsoleCommandDelegate& Command, uint32 Flags) override;
    virtual IConsoleCommand* RegisterConsoleCommand(const TCHAR* Name, const TCHAR* Help, const FConsoleCommandWithArgsDelegate& Command, uint32 Flags) override;
    virtual IConsoleCommand* RegisterConsoleCommand(const TCHAR* Name, const TCHAR* Help, const FConsoleCommandWithWorldDelegate& Command, uint32 Flags) override;
    virtual IConsoleCommand* RegisterConsoleCommand(const TCHAR* Name, const TCHAR* Help, const FConsoleCommandWithWorldAndArgsDelegate& Command, uint32 Flags) override;
    virtual IConsoleCommand* RegisterConsoleCommand(const TCHAR* Name, const TCHAR* Help, const FConsoleCommandWithArgsAndOutputDeviceDelegate& Command, uint32 Flags) override;
    virtual IConsoleCommand* RegisterConsoleCommand(const TCHAR* Name, const TCHAR* Help, const FConsoleCommandWithWorldArgsAndOutputDeviceDelegate& Command, uint32 Flags) override;
    virtual IConsoleCommand* RegisterConsoleCommand(const TCHAR* Name, const TCHAR* Help, const FConsoleCommandWithOutputDeviceDelegate& Command, uint32 Flags) override;
    virtual IConsoleCommand* RegisterConsoleCommand(const TCHAR* Name, const TCHAR* Help, uint32 Flags) override;
 
    virtual FConsoleVariableMulticastDelegate& OnCVarUnregistered()override;
    virtual FConsoleObjectWithNameMulticastDelegate& OnConsoleObjectUnregistered() override;
 
    virtual FString FindConsoleObjectName(const IConsoleObject* Obj) const override;
    virtual IConsoleObject* FindConsoleObject(const TCHAR* Name, bool bTrackFrequentCalls = true) const override;
    virtual IConsoleVariable* FindConsoleVariable(const TCHAR* Name, bool bTrackFrequentCalls = true) const override;
 
    virtual FConsoleVariableSinkHandle RegisterConsoleVariableSink_Handle(const FConsoleCommandDelegate& Command) override;
    virtual void UnregisterConsoleVariableSink_Handle(FConsoleVariableSinkHandle Handle) override;
    virtual void CallAllConsoleVariableSinks() override;
 
    virtual void ForEachConsoleObjectThatStartsWith(const FConsoleObjectVisitor& Visitor, const TCHAR* ThatStartsWith) const override;
    virtual void ForEachConsoleObjectThatContains(const FConsoleObjectVisitor& Visitor, const TCHAR* ThatContains) const override;
    virtual bool ProcessUserConsoleInput(const TCHAR* InInput, FOutputDevice& Ar, UWorld* InWorld) override;
    virtual void AddConsoleHistoryEntry(const TCHAR* Key, const TCHAR* Input) override;
    virtual void GetConsoleHistory(const TCHAR* Key, TArray<FString>& Out) override;
    virtual bool IsNameRegistered(const TCHAR* Name) const override;
    virtual void RegisterThreadPropagation(uint32 ThreadId, IConsoleThreadPropagation* InCallback) override;
    virtual void UnregisterConsoleObject(IConsoleObject* Object, bool bKeepState) override;
    virtual void UnsetAllConsoleVariablesWithTag(FName Tag, EConsoleVariableFlags Priority) override;
    virtual void BatchUpdateTag(FName Tag, const TMap<FName, FString>& CVarsAndValues) override;
 
#if ALLOW_OTHER_PLATFORM_CONFIG
    virtual void LoadAllPlatformCVars(FName PlatformName, const FString& DeviceProfileName = FString()) override;
    virtual void ClearAllPlatformCVars(FName PlatformName = NAME_None, const FString& DeviceProfileName = FString()) override;
    virtual void PreviewPlatformCVars(FName PlatformName, const FString& DeviceProfileName, FName PreviewModeTag) override;
    virtual void StompPlatformCVars(FName PlatformName, const FString& DeviceProfileName, FName Tag, EConsoleVariableFlags SetBy, EConsoleVariableFlags RequiredFlags, EConsoleVariableFlags DisallowedFlags) override;
#endif
 
     IConsoleObject* AddConsoleObject(const TCHAR* Name, IConsoleObject* Obj);
 
    void AddShadowConsoleObject(const TCHAR* Name, IConsoleObject* Obj);
 
    IConsoleThreadPropagation* GetThreadPropagationCallback();
 
    bool IsThreadPropagationThread();
 
    void OnCVarChanged();
    void DumpObjects(const TCHAR* Params, FOutputDevice& InAr, bool bDisplayCommands) const;
 
#if ALLOW_OTHER_PLATFORM_CONFIG
    void OnCreatedPlatformCVar(IConsoleVariable* MainVariable, TSharedPtr<IConsoleVariable> PlatformVariable, FName PlatformKey);
#endif
 
private:
 
    static bool MatchPartialName(const TCHAR* Stream, const TCHAR* Pattern);
 
    static bool MatchSubstring(const TCHAR* Stream, const TCHAR* Pattern);
 
    static FString GetTextSection(const TCHAR*& It);
 
    IConsoleObject* FindConsoleObjectUnfiltered(const TCHAR* Name) const;
 
    void UnregisterConsoleObject(const TCHAR* Name, bool bKeepState);
 
    void LoadHistoryIfNeeded();
 
    void SaveHistory();
 
    TMap<FString, IConsoleObject*> ConsoleObjects;
 
    bool bHistoryWasLoaded;
    TMap<FString, TArray<FString>> HistoryEntriesMap;
    TArray<FConsoleCommandDelegate> ConsoleVariableChangeSinks;
    FConsoleVariableMulticastDelegate ConsoleVariableUnregisteredDelegate;
    FConsoleObjectWithNameMulticastDelegate ConsoleObjectUnregisteredDelegate;
    IConsoleThreadPropagation* ThreadPropagationCallback;
    FCriticalSection CachedPlatformsAndDeviceProfilesLock;
    TSet<FName> CachedPlatformsAndDeviceProfiles;
    TMultiMap<FString, TTuple<FString, EConsoleVariableFlags>> UnknownCVarCache;
 
    bool bCallAllConsoleVariableSinks;
 
    mutable FTransactionallySafeCriticalSection ConsoleObjectsSynchronizationObject;
};