LiveLinkLog.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "LiveLinkTypes.h"
#include "Logging/TokenizedMessage.h"
#include "Templates/IsArrayOrRefOfTypeByPredicate.h"
#include "Templates/SharedPointer.h"
#include "Templates/UniquePtr.h"
#include "Traits/IsCharEncodingCompatibleWith.h"
#include "UObject/NameTypes.h"
#include "UObject/UnrealNames.h"
 
struct FTimespan;
 
#define ENABLE_LIVELINK_LOGGING (!NO_LOGGING && !UE_BUILD_TEST)
 
class FLiveLinkLog
{
public:
    template<typename... ArgsType>
    static void Error(UE::Core::TCheckedFormatString<FString::FmtCharType, ArgsType...> Format, ArgsType... Args)
    {
        Log_Internal(EMessageSeverity::Error, NAME_None, FLiveLinkSubjectKey(), Format, Args...);
    }
 
    template<typename... ArgsType>
    static void ErrorOnce(FName MessageID,
                                                const FLiveLinkSubjectKey& SubjectKey,
                                                UE::Core::TCheckedFormatString<FString::FmtCharType, ArgsType...> Format,
                                                ArgsType... Args)
    {
        Log_Internal(EMessageSeverity::Error, MessageID, SubjectKey, Format, Args...);
    }
    
    template<typename... ArgsType>
    static void Warning(UE::Core::TCheckedFormatString<FString::FmtCharType, ArgsType...> Format, ArgsType... Args)
    {
        Log_Internal(EMessageSeverity::Warning, NAME_None, FLiveLinkSubjectKey(), Format, Args...);
    }
 
    template<typename... ArgsType>
    static void WarningOnce(FName MessageID,
                                                    const FLiveLinkSubjectKey& SubjectKey,
                                                    UE::Core::TCheckedFormatString<FString::FmtCharType, ArgsType...> Format,
                                                    ArgsType... Args)
    {
        Log_Internal(EMessageSeverity::Warning, MessageID, SubjectKey, Format, Args...);
    }
    
    template<typename... ArgsType>
    static void Info(UE::Core::TCheckedFormatString<FString::FmtCharType, ArgsType...> Format, ArgsType... Args)
    {
        Log_Internal(EMessageSeverity::Info, NAME_None, FLiveLinkSubjectKey(), Format, Args...);
    }
 
    template<typename... ArgsType>
    static void InfoOnce(FName MessageID,
                                             const FLiveLinkSubjectKey& SubjectKey,
                                             UE::Core::TCheckedFormatString<FString::FmtCharType, ArgsType...> Format,
                                             ArgsType... Args)
    {
        Log_Internal(EMessageSeverity::Info, MessageID, SubjectKey, Format, Args...);
    }
 
    template<typename... ArgsType>
    static TSharedPtr<FTokenizedMessage> TokenizedMessage(EMessageSeverity::Type Severity,
                                                                                                                UE::Core::TCheckedFormatString<FString::FmtCharType, ArgsType...> Format,
                                                                                                                ArgsType... Args)
    {
        return CreateTokenizedMessage_Internal(Severity, NAME_None, FLiveLinkSubjectKey(), Format, Args...);
    }
 
    template<typename... ArgsType>
    static TSharedPtr<FTokenizedMessage> TokenizedMessageOnce(EMessageSeverity::Type Severity,
                                                                                                                        FName MessageID,
                                                                                                                        const FLiveLinkSubjectKey& SubjectKey,
                                                                                                                        UE::Core::TCheckedFormatString<FString::FmtCharType, ArgsType...> Format,
                                                                                                                        ArgsType... Args)
    {
        return CreateTokenizedMessage_Internal(Severity, MessageID, SubjectKey, Format, Args...);
    }
 
    static FLiveLinkLog* GetInstance() { return Instance.Get(); }
 
public:
    virtual ~FLiveLinkLog() = default;
 
    virtual TPair<int32, FTimespan> GetOccurrence(FName MessageID, FLiveLinkSubjectKey SubjectKey) const = 0;
 
    virtual TPair<int32, FTimespan> GetSelectedOccurrence() const = 0;
 
    virtual void GetLogCount(int32& OutErrorCount, int32& OutWarningCount, int32& OutInfoCount) const = 0;
 
private:
    template<typename... ArgsType>
    static void Log_Internal(EMessageSeverity::Type Severity,
                                                     FName MessageID,
                                                     const FLiveLinkSubjectKey& SubjectKey,
                                                     UE::Core::TCheckedFormatString<FString::FmtCharType, ArgsType...> Format,
                                                     ArgsType... Args)
    {
#if ENABLE_LIVELINK_LOGGING
        if (Instance)
        {
            Instance->LogMessage(Severity, MessageID, SubjectKey, FString::Printf(Format, Args...));
        }
#endif
    }
 
    template<typename... ArgsType>
    static TSharedPtr<FTokenizedMessage> CreateTokenizedMessage_Internal(EMessageSeverity::Type Severity,
                                                                                                                                             FName MessageID,
                                                                                                                                             const FLiveLinkSubjectKey& SubjectKey,
                                                                                                                                             UE::Core::TCheckedFormatString<FString::FmtCharType, ArgsType...> Format,
                                                                                                                                             ArgsType... Args)
    {
#if ENABLE_LIVELINK_LOGGING
        if (Instance)
        {
            return Instance->CreateTokenizedMessage(Severity, MessageID, SubjectKey, FString::Printf(Format, Args...));
        }
#endif
        return TSharedPtr<FTokenizedMessage>();
    }
 
protected:
    virtual void LogMessage(EMessageSeverity::Type Severity, FName MessageID, const FLiveLinkSubjectKey& SubjectKey, FString&& Message) = 0;
    virtual TSharedPtr<FTokenizedMessage> CreateTokenizedMessage(EMessageSeverity::Type Severity, FName MessageID, const FLiveLinkSubjectKey& SubjectKey, FString&& Message) = 0;
 
protected:
    static LIVELINKINTERFACE_API TUniquePtr<FLiveLinkLog> Instance;
};