logUtilities.h

Go to the documentation of this file.

 
#pragma once
 
 
 
// UE
 
#include "HAL/UnrealMemory.h"
 
#include "Kismet/GameplayStatics.h"
 
#include "Kismet/KismetSystemLibrary.h"
 
 
 
// Ref "Misc/GeneratedTypeName.h"
 
#if defined(_MSC_VER) && !defined(__clang__)
 
#define RCLUE_FUNC_LOG __FUNCSIG__
 
#else
 
#define RCLUE_FUNC_LOG __PRETTY_FUNCTION__
 
#endif
 
 
 
 
#define __FILENAME__ (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
 
 
 
// clang-format off
 
// to avoid change line by clang-format. Doxygen can't handle constant macro with multiple lines.
 
#define __LOG_INFO__  FString(__FILENAME__).Append(TEXT("@")).Append(FString::FromInt(__LINE__)).Append(TEXT(", ")).Append(RCLUE_FUNC_LOG)
 
// clang-format on
 
 
 
#define UE_LOG_WITH_INFO(CategoryName, Verbosity, ...)                                                  \
 
    {                                                                                                   \
 
        UE_LOG(CategoryName, Verbosity, TEXT("[%s] %s"), *__LOG_INFO__, *FString::Printf(__VA_ARGS__)); \
 
    }
 
 
 
#define UE_LOG_WITH_INFO_SHORT(CategoryName, Verbosity, ...)                                                                     \
 
    {                                                                                                                            \
 
        FString UE_LOG_WITH_INFO_Temp1, UE_LOG_WITH_INFO_Temp2;                                                                  \
 
        FString(RCLUE_FUNC_LOG)                                                                                                  \
 
            .Split(                                                                                                              \
 
                TEXT("("), &UE_LOG_WITH_INFO_Temp1, &UE_LOG_WITH_INFO_Temp2, ESearchCase::CaseSensitive, ESearchDir::FromStart); \
 
        UE_LOG_WITH_INFO_Temp1.Split(                                                                                            \
 
            TEXT(" "), &UE_LOG_WITH_INFO_Temp1, &UE_LOG_WITH_INFO_Temp2, ESearchCase::CaseSensitive, ESearchDir::FromEnd);       \
 
        UE_LOG(CategoryName, Verbosity, TEXT("[%s@%d] %s"), *UE_LOG_WITH_INFO_Temp2, __LINE__, *FString::Printf(__VA_ARGS__));   \
 
    }
 
 
 
#define UE_LOG_WITH_INFO_NAMED(CategoryName, Verbosity, ...)                                                   \
 
    {                                                                                                          \
 
        UE_LOG_WITH_INFO(CategoryName, Verbosity, TEXT("[%s] %s"), *GetName(), *FString::Printf(__VA_ARGS__)); \
 
    }
 
 
 
#define UE_LOG_WITH_INFO_SHORT_NAMED(CategoryName, Verbosity, ...)                                                   \
 
    {                                                                                                                \
 
        UE_LOG_WITH_INFO_SHORT(CategoryName, Verbosity, TEXT("[%s] %s"), *GetName(), *FString::Printf(__VA_ARGS__)); \
 
    }
 
 
 
#define UE_LOG_THROTTLE(InRate, InLastHit, ...)                                   \
 
    {                                                                             \
 
        float UE_LOG_THROTTLE_Now = UGameplayStatics::GetTimeSeconds(GetWorld()); \
 
        if (InLastHit + InRate <= UE_LOG_THROTTLE_Now)                            \
 
        {                                                                         \
 
            InLastHit = UE_LOG_THROTTLE_Now;                                      \
 
            UE_LOG(__VA_ARGS__);                                                  \
 
        }                                                                         \
 
    }
 
 
 
#define UE_LOG_WITH_INFO_THROTTLE(InRate, InLastHit, ...)                                   \
 
    {                                                                                       \
 
        float UE_LOG_WITH_INFO_THROTTLE_Now = UGameplayStatics::GetTimeSeconds(GetWorld()); \
 
        if (InLastHit + InRate <= UE_LOG_WITH_INFO_THROTTLE_Now)                            \
 
        {                                                                                   \
 
            InLastHit = UE_LOG_WITH_INFO_THROTTLE_Now;                                      \
 
            UE_LOG_WITH_INFO(__VA_ARGS__);                                                  \
 
        }                                                                                   \
 
    }
 
 
 
#define UE_LOG_WITH_INFO_SHORT_THROTTLE(InRate, InLastHit, ...)                             \
 
    {                                                                                       \
 
        float UE_LOG_WITH_INFO_THROTTLE_Now = UGameplayStatics::GetTimeSeconds(GetWorld()); \
 
        if (InLastHit + InRate <= UE_LOG_WITH_INFO_THROTTLE_Now)                            \
 
        {                                                                                   \
 
            InLastHit = UE_LOG_WITH_INFO_THROTTLE_Now;                                      \
 
            UE_LOG_WITH_INFO_SHORT(__VA_ARGS__);                                            \
 
        }                                                                                   \
 
    }
 
 
 
#define UE_LOG_WITH_INFO_NAMED_THROTTLE(InRate, InLastHit, ...)                                   \
 
    {                                                                                             \
 
        float UE_LOG_WITH_INFO_NAMED_THROTTLE_Now = UGameplayStatics::GetTimeSeconds(GetWorld()); \
 
        if (InLastHit + InRate <= UE_LOG_WITH_INFO_NAMED_THROTTLE_Now)                            \
 
        {                                                                                         \
 
            InLastHit = UE_LOG_WITH_INFO_NAMED_THROTTLE_Now;                                      \
 
            UE_LOG_WITH_INFO_NAMED(__VA_ARGS__);                                                  \
 
        }                                                                                         \
 
    }
 
 
 
#define UE_LOG_WITH_INFO_SHORT_NAMED_THROTTLE(InRate, InLastHit, ...)                             \
 
    {                                                                                             \
 
        float UE_LOG_WITH_INFO_NAMED_THROTTLE_Now = UGameplayStatics::GetTimeSeconds(GetWorld()); \
 
        if (InLastHit + InRate <= UE_LOG_WITH_INFO_NAMED_THROTTLE_Now)                            \
 
        {                                                                                         \
 
            InLastHit = UE_LOG_WITH_INFO_NAMED_THROTTLE_Now;                                      \
 
            UE_LOG_WITH_INFO_SHORT_NAMED(__VA_ARGS__);                                            \
 
        }                                                                                         \
 
    }