OutputDeviceRedirector.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/ContainerAllocationPolicies.h"
#include "CoreTypes.h"
#include "Logging/LogVerbosity.h"
#include "Misc/EnumClassFlags.h"
#include "Misc/NotNull.h"
#include "Misc/OutputDevice.h"
#include "Templates/PimplPtr.h"
#include "Templates/UniquePtr.h"
#include "UObject/NameTypes.h"
 
/*-----------------------------------------------------------------------------
FOutputDeviceRedirector.
-----------------------------------------------------------------------------*/
 
class FOutputDeviceFence;
namespace UE::Private { struct FOutputDeviceRedirectorState; }
 
struct FBufferedLine
{
    TUniquePtr<TCHAR[]> Data;
    const FLazyName Category;
    const double Time;
    const ELogVerbosity::Type Verbosity;
    bool bExternalAllocation;
 
    CORE_API explicit FBufferedLine(const TCHAR* InData, const FName& InCategory, ELogVerbosity::Type InVerbosity, const double InTime = -1);
};
 
enum class EOutputDeviceRedirectorFlushOptions : uint32
{
    None = 0,
 
    Async = 1 << 0,
};
 
ENUM_CLASS_FLAGS(EOutputDeviceRedirectorFlushOptions);
 
class FOutputDeviceRedirector final : public FOutputDevice
{
public:
    CORE_API FOutputDeviceRedirector();
    
    CORE_API ~FOutputDeviceRedirector();
 
    static CORE_API FOutputDeviceRedirector* Get();
 
    CORE_API void AddOutputDevice(FOutputDevice* OutputDevice);
 
    CORE_API void RemoveOutputDevice(FOutputDevice* OutputDevice);
 
    CORE_API bool IsRedirectingTo(FOutputDevice* OutputDevice);
 
    CORE_API void FlushThreadedLogs(EOutputDeviceRedirectorFlushOptions Options = EOutputDeviceRedirectorFlushOptions::None);
 
    UE_DEPRECATED(5.7, "The backlog is now automatically serialized within AddOutputDevice.")
    CORE_API void SerializeBacklog(FOutputDevice* OutputDevice);
 
    CORE_API void EnableBacklog(bool bEnable);
 
    CORE_API void SetCurrentThreadAsPrimaryThread();
 
    CORE_API bool TryStartDedicatedPrimaryThread();
 
    CORE_API void SerializeRecord(const UE::FLogRecord& Record) final;
 
    CORE_API void Serialize(const TCHAR* Data, ELogVerbosity::Type Verbosity, const FName& Category, const double Time) final;
 
    CORE_API void Serialize(const TCHAR* Data, ELogVerbosity::Type Verbosity, const FName& Category) final;
 
    CORE_API void RedirectLog(const FName& Category, ELogVerbosity::Type Verbosity, const TCHAR* Data);
    CORE_API void RedirectLog(const FLazyName& Category, ELogVerbosity::Type Verbosity, const TCHAR* Data);
 
    CORE_API FOutputDeviceFence CreateFence();
 
    CORE_API void Flush() final;
 
    CORE_API void Panic();
 
    CORE_API void TearDown() final;
 
    UE_DEPRECATED(5.7, "The backlog is now automatically serialized within AddOutputDevice.")
    CORE_API bool IsBacklogEnabled() const;
 
    UE_INTERNAL bool HasBacklogForCrash() const;
    UE_INTERNAL void SerializeBacklogForCrash(TNotNull<FOutputDevice*> OutputDevice) const;
 
private:
    TPimplPtr<UE::Private::FOutputDeviceRedirectorState> State;
};
 
class FOutputDeviceFence
{
public:
    CORE_API void Wait() const;
    CORE_API bool Poll() const;
 
private:
    FOutputDeviceFence() = default;
 
    UE::Private::FOutputDeviceRedirectorState* State = nullptr;
    uint64 Index = 0;
 
    friend FOutputDeviceRedirector;
};