LogCategory.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Logging/LogVerbosity.h"
#include "UObject/NameTypes.h"
 
#define UE_API CORE_API
 
#if defined(UE_LOG_LAZY_CATEGORY_NAMES) && UE_LOG_LAZY_CATEGORY_NAMES
using FLogCategoryName = FLazyName;
#define UE_FNAME_TO_LOG_CATEGORY_NAME(Name) FLazyName(Name)
#else
using FLogCategoryName = FName;
#define UE_FNAME_TO_LOG_CATEGORY_NAME(Name) Name
#endif
 
struct FLogCategoryBase
{
    UE_API FLogCategoryBase(const FLogCategoryName& CategoryName, ELogVerbosity::Type DefaultVerbosity, ELogVerbosity::Type CompileTimeVerbosity);
 
    UE_API FLogCategoryBase(const TCHAR* CategoryName, ELogVerbosity::Type DefaultVerbosity, ELogVerbosity::Type CompileTimeVerbosity);
 
    UE_API ~FLogCategoryBase();
 
    UE_FORCEINLINE_HINT constexpr bool IsSuppressed(ELogVerbosity::Type VerbosityLevel) const
    {
        return !((VerbosityLevel & ELogVerbosity::VerbosityMask) <= Verbosity);
    }
 
    UE_API void PostTrigger(ELogVerbosity::Type VerbosityLevel);
 
    inline constexpr const FLogCategoryName& GetCategoryName() const { return CategoryName; }
 
    inline constexpr ELogVerbosity::Type GetVerbosity() const { return (ELogVerbosity::Type)Verbosity; }
    
    UE_API void SetVerbosity(ELogVerbosity::Type Verbosity);
 
    inline constexpr ELogVerbosity::Type GetCompileTimeVerbosity() const { return CompileTimeVerbosity; }
 
private:
    friend class FLogSuppressionImplementation;
    friend class FLogScopedVerbosityOverride;
 
    void ResetFromDefault();
 
    ELogVerbosity::Type Verbosity;
    bool DebugBreakOnLog;
    uint8 DefaultVerbosity;
    const ELogVerbosity::Type CompileTimeVerbosity;
    const FLogCategoryName CategoryName;
};
 
template <ELogVerbosity::Type InDefaultVerbosity, ELogVerbosity::Type InCompileTimeVerbosity>
struct FLogCategory : public FLogCategoryBase
{
    static_assert((InDefaultVerbosity & ELogVerbosity::VerbosityMask) < ELogVerbosity::NumVerbosity, "Bogus default verbosity.");
    static_assert(InCompileTimeVerbosity < ELogVerbosity::NumVerbosity, "Bogus compile time verbosity.");
 
    static constexpr ELogVerbosity::Type CompileTimeVerbosity = InCompileTimeVerbosity;
 
    inline constexpr ELogVerbosity::Type GetCompileTimeVerbosity() const { return CompileTimeVerbosity; }
 
    UE_FORCEINLINE_HINT FLogCategory(const FLogCategoryName& InCategoryName)
        : FLogCategoryBase(InCategoryName, InDefaultVerbosity, CompileTimeVerbosity)
    {
    }
 
    UE_FORCEINLINE_HINT FLogCategory(const TCHAR* InCategoryName)
        : FLogCategoryBase(InCategoryName, InDefaultVerbosity, CompileTimeVerbosity)
    {
    }
};
 
#undef UE_API