MessageLog.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/SortedMap.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "Internationalization/Text.h"
#include "Logging/LogVerbosity.h"
#include "Logging/TokenizedMessage.h"
#include "Templates/SharedPointer.h"
#include "UObject/NameTypes.h"
#include "HAL/LowLevelMemTracker.h"
 
class IMessageLog;
 
LLM_DECLARE_TAG_API(EngineMisc_MessageLog, CORE_API);
 
class FMessageLog
{
public:
    CORE_API FMessageLog( const FName& InLogName );
 
    CORE_API ~FMessageLog();
 
    CORE_API void Flush();
 
    CORE_API const TSharedRef<FTokenizedMessage>& AddMessage( const TSharedRef<FTokenizedMessage>& InMessage );
 
    CORE_API void AddMessages( const TArray< TSharedRef<FTokenizedMessage> >& InMessages );
 
    CORE_API TSharedRef<FTokenizedMessage> Message( EMessageSeverity::Type InSeverity, const FText& InMessage = FText() );
    UE_DEPRECATED(5.1, "CriticalError was removed because it can't trigger an assert at the callsite. Use 'checkf' instead.")
    CORE_API TSharedRef<FTokenizedMessage> CriticalError(const FText& InMessage = FText());
    CORE_API TSharedRef<FTokenizedMessage> Error( const FText& InMessage = FText() );
    CORE_API TSharedRef<FTokenizedMessage> PerformanceWarning( const FText& InMessage = FText() );
    CORE_API TSharedRef<FTokenizedMessage> Warning( const FText& InMessage = FText() );
    CORE_API TSharedRef<FTokenizedMessage> Info( const FText& InMessage = FText() );
 
    CORE_API int32 NumMessages( EMessageSeverity::Type InSeverityFilter = EMessageSeverity::Info );
 
    CORE_API void Open( EMessageSeverity::Type InSeverityFilter = EMessageSeverity::Info, bool bOpenEvenIfEmpty = false );
 
    CORE_API void Notify( const FText& InMessage = FText(), EMessageSeverity::Type InSeverityFilter = EMessageSeverity::Info, bool bForce = false );
 
    CORE_API void NewPage( const FText& InLabel );
 
    CORE_API void SetCurrentPage( const FText& InLabel );
 
    CORE_API FMessageLog& SuppressLoggingToOutputLog(bool bShouldSuppress = true);
 
    DECLARE_DELEGATE_RetVal_OneParam( TSharedRef<class IMessageLog>, FGetLog, const FName& );
    static FGetLog& OnGetLog() { return GetLog; }
 
    DECLARE_DELEGATE_OneParam( FMessageSelectionChanged, TArray< TSharedRef<FTokenizedMessage> >& );
    static FMessageSelectionChanged& OnMessageSelectionChanged() { return MessageSelectionChanged; }
 
    CORE_API static ELogVerbosity::Type GetLogVerbosity( EMessageSeverity::Type InSeverity );
 
    CORE_API static const TCHAR* const GetLogColor( EMessageSeverity::Type InSeverity );
 
    DECLARE_DELEGATE(FMultiSelectActorBegin);
    static FMultiSelectActorBegin& OnMultiSelectActorBegin() { return MultiSelectActorBegin; }
 
    DECLARE_DELEGATE(FMultiSelectActorEnd);
    static FMultiSelectActorEnd& OnMultiSelectActorEnd() { return MultiSelectActorEnd; }
 
private:
    TArray< TSharedRef<FTokenizedMessage> > Messages;
 
    TSharedPtr<class IMessageLog> MessageLog;
 
    FName LogName;
 
    bool bSuppressLoggingToOutputLog;
 
    CORE_API static FGetLog GetLog;
 
    CORE_API static FMessageSelectionChanged MessageSelectionChanged;
 
    CORE_API static FMultiSelectActorBegin MultiSelectActorBegin;
    CORE_API static FMultiSelectActorEnd MultiSelectActorEnd;
};
 
class FMessageLogScopedOverride final
{
public:
    CORE_API explicit FMessageLogScopedOverride(const FName InLogName);
    CORE_API ~FMessageLogScopedOverride();
 
    UE_NONCOPYABLE(FMessageLogScopedOverride);
 
    CORE_API FMessageLogScopedOverride& SuppressLoggingToOutputLog(const bool bShouldSuppress = true);
 
    CORE_API FMessageLogScopedOverride& RemapMessageSeverity(const EMessageSeverity::Type SrcSeverity, const EMessageSeverity::Type DestSeverity);
 
private:
    friend class FMessageLog;
 
    FName LogName;
    TOptional<bool> bSuppressLoggingToOutputLog;
    TSortedMap<EMessageSeverity::Type, EMessageSeverity::Type> MessageSeverityRemapping;
};