Console.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "InputCoreTypes.h"
#include "Engine/EngineBaseTypes.h"
#include "ConsoleSettings.h"
 
#include "Console.generated.h"
 
class FViewport;
class SWidget;
struct FAutoCompleteCommand;
class FCanvasTextItem;
class FCanvasTileItem;
class UFont;
 
USTRUCT()
struct FAutoCompleteNode
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY()
    int32 IndexChar;
 
    UPROPERTY()
    TArray<int32> AutoCompleteListIndices;
 
    TArray<FAutoCompleteNode*> ChildNodes;
 
    FAutoCompleteNode()
    {
        IndexChar = INDEX_NONE;
    }
 
    FAutoCompleteNode(int32 NewChar)
    {
        IndexChar = NewChar;
    }
 
    ~FAutoCompleteNode()
    {
        for (int32 Idx = 0; Idx < ChildNodes.Num(); Idx++)
        {
            FAutoCompleteNode *Node = ChildNodes[Idx];
            delete Node;
        }
        ChildNodes.Empty();
    }   
};
 
 
UCLASS(Within=GameViewportClient, config=Input, transient, MinimalAPI)
class UConsole
    : public UObject
    , public FOutputDevice
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY()
    TObjectPtr<class ULocalPlayer> ConsoleTargetPlayer;
 
    UPROPERTY()
    TObjectPtr<class UTexture2D> DefaultTexture_Black;
 
    UPROPERTY()
    TObjectPtr<class UTexture2D> DefaultTexture_White;
 
    TArray<FString> Scrollback;
 
    int32 SBHead;
 
    int32 SBPos;
 
    static const int32 MAX_HISTORY_ENTRIES = 50;
 
    UPROPERTY(config)
    TArray<FString> HistoryBuffer;
 
    FString TypedStr;
 
    int32 TypedStrPos;    //Current position in TypedStr
 
    FString PrecompletedInputLine;
 
    FString LastAutoCompletedCommand;
 
    uint32 bCaptureKeyInput:1;
 
    uint32 bCtrl:1;
 
    uint32 bShift:1;
 
    TArray<FAutoCompleteCommand> AutoCompleteList;
 
    uint32 bAutoCompleteLocked:1;
 
    int32 AutoCompleteIndex;
 
    int32 AutoCompleteCursor;
 
    uint32 bIsRuntimeAutoCompleteUpToDate:1;
 
    // NAME_Typing, NAME_Open or NAME_None
    FName ConsoleState;
 
    FAutoCompleteNode AutoCompleteTree;
 
    TArray<FAutoCompleteCommand> AutoComplete;
 
    // Scrollback region selection mouse and state
    struct ScrollbackSelection
    {
        FVector2f MousePosDown = FVector2f(0.0f, 0.0f);
        FVector2f MousePosUp = FVector2f(0.0f, 0.0f);
        FVector2f MousePos = FVector2f(0.0f, 0.0f);
        bool bActive = false;
        bool bCapture = false;
        bool bMade = false;
        float Offset = 0.0f;
    } Selection;
 
    float TextW = 15.0f;
    float TextH = 15.0f;
 
    ENGINE_API ~UConsole();
 
    // UObject Interface
    ENGINE_API virtual void PostInitProperties() override;
 
    ENGINE_API virtual void SetInputText( const FString& Text );
 
    ENGINE_API virtual void SetCursorPos( int32 Position );
    
    ENGINE_API virtual void ConsoleCommand(const FString& Command);
    
    ENGINE_API virtual void ClearOutput();
    
    ENGINE_API virtual void OutputText(const FString& Text);
    
    ENGINE_API virtual void StartTyping(const FString& Text);
    
    ENGINE_API virtual void FlushPlayerInput();
    
    ENGINE_API virtual bool ProcessControlKey(FKey Key, EInputEvent Event);
 
    ENGINE_API virtual bool ProcessShiftKey(FKey Key, EInputEvent Event);
    
    ENGINE_API virtual void AppendInputText(const FString& Text);
    
    ENGINE_API virtual void BuildRuntimeAutoCompleteList(bool bForce = false);
 
    ENGINE_API virtual void AugmentRuntimeAutoCompleteList(TArray<FAutoCompleteCommand>& List);
    
    ENGINE_API virtual void UpdateCompleteIndices();
 
    ENGINE_API virtual bool InputChar_Typing(FInputDeviceId DeviceId, const FString& Unicode);
    
    ENGINE_API virtual void PostRender_Console_Typing(class UCanvas* Canvas);
    
    ENGINE_API virtual void BeginState_Typing(FName PreviousStateName);
 
    ENGINE_API virtual void EndState_Typing( FName NextStateName );
 
    ENGINE_API virtual bool InputChar_Open( FInputDeviceId DeviceId, const FString& Unicode );
 
    ENGINE_API virtual bool InputKey_Open(FInputDeviceId DeviceId, FKey Key, EInputEvent Event, float AmountDepressed = 1.f, bool bGamepad = false);
    
    ENGINE_API virtual void PostRender_Console_Open(class UCanvas* Canvas);
 
    ENGINE_API virtual void BeginState_Open(FName PreviousStateName);
 
    ENGINE_API virtual void EndState_Open(FName NextStateName);
    
    ENGINE_API virtual bool InputChar(FInputDeviceId DeviceId, const FString& Unicode);
    
    ENGINE_API virtual bool InputKey(FInputDeviceId DeviceId, FKey Key, EInputEvent Event, float AmountDepressed=1.f, bool bGamepad=false);
    
    virtual bool InputAxis(FInputDeviceId DevideId, FKey Key, float Delta, float DeltaTime, int32 NumSamples=1, bool bGamepad=false) { return false; };
    
    virtual bool InputTouch(FInputDeviceId DevideId, uint32 Handle, ETouchType::Type Type, const FVector2D& TouchLocation, float Force, FDateTime DeviceTimestamp, uint32 TouchpadIndex) { return false; }
 
    ENGINE_API virtual void MouseMove(FViewport* Viewport, int32 X, int32 Y);
    ENGINE_API virtual void CapturedMouseMove(FViewport* InViewport, int32 X, int32 Y);
 
    ENGINE_API virtual void PostRender_Console(class UCanvas* Canvas);
 
    ENGINE_API virtual void FakeGotoState(FName NextStateName);
 
    ENGINE_API virtual bool ConsoleActive() const;
 
    ENGINE_API void InvalidateAutocomplete();
 
    DECLARE_MULTICAST_DELEGATE_OneParam(FRegisterConsoleAutoCompleteEntries, TArray<FAutoCompleteCommand>&);
    static ENGINE_API FRegisterConsoleAutoCompleteEntries RegisterConsoleAutoCompleteEntries;
 
    DECLARE_MULTICAST_DELEGATE_OneParam(FOnConsoleActivationStateChanged, bool);
    static ENGINE_API FOnConsoleActivationStateChanged OnConsoleActivationStateChanged;
 
private:
 
    bool InputKey_InputLine(FInputDeviceId DeviceId, FKey Key, EInputEvent Event, float AmountDepressed = 1.f, bool bGamepad = false);
 
    // interface FOutputDevice
    ENGINE_API virtual void Serialize( const TCHAR* V, ELogVerbosity::Type Verbosity, const class FName& Category ) override;
    // expose the base class other Serialize function (clang will give "error : 'UConsole::Serialize' hides overloaded virtual function" without this)
    using UObject::Serialize; 
 
    void OutputTextLine(const FString& Text);
 
    void PostRender_InputLine(class UCanvas* Canvas, FIntPoint UserInputLinePos);
 
    void SetAutoCompleteFromHistory();
 
    void SetInputLineFromAutoComplete();
 
    void UpdatePrecompletedInputLine();
 
    void NormalizeHistoryBuffer();
 
    // Scrollback region selection utilities
    void DrawLine(
        UCanvas* Canvas, UFont* Font, FCanvasTileItem& TileBlack, FCanvasTileItem& TileWhite,
        FCanvasTextItem ConsoleText, const FString& Line, float PenX, float PenY, float PosLeft,
        TArray<FString>& SelectedLines);
    void GetPosInTextLine(UCanvas* Canvas, UFont* Font, const FString& Line, float MousePosX, float& PosInLine, int32& PosInString);
    float GetPosTextLineEnd(UCanvas* Canvas, UFont* Font, const FString& Line);
 
    // Console settings from BaseInput.ini
    const UConsoleSettings* ConsoleSettings;
 
    // Widget that was focused before the console was opened (focus will be restored to this if it's valid after the console closes)
    TWeakPtr<SWidget> PreviousFocusedWidget;
 
    // Previous mouse capture mode of the viewport before the console was opened (mouse capture mode must be restored to its previous state)
    EMouseCaptureMode PreviousMouseCaptureMode = EMouseCaptureMode::CapturePermanently;
 
    const bool bDPIAwareStringMeasurement = true;
};