integration/EnginePatches/LogMacros.cpp

// Copyright Epic Games, Inc. All Rights Reserved.

#include "Logging/LogMacros.h"
#include "CoreGlobals.h"
#include "HAL/Platform.h"
#include "Misc/ScopeLock.h"
#include "Misc/OutputDeviceRedirector.h"
#include "Misc/FeedbackContext.h"
#include "Misc/VarargsHelper.h"
#include "Stats/Stats.h"
#include "ProfilingDebugging/CsvProfiler.h"

namespace UBreakPoint {
	volatile int OnLogError_V;
	FORCENOINLINE static void OnLogError() {
		OnLogError_V = 0;
	}
}

void StaticFailDebugV(const TCHAR* Error, const ANSICHAR* Expression, const ANSICHAR* File, int32 Line, bool bIsEnsure, void* ProgramCounter, const TCHAR* DescriptionFormat, va_list DescriptionArgs);

CSV_DEFINE_CATEGORY(FMsgLogf, true);

void FMsg::LogfImpl(const ANSICHAR* File, int32 Line, const FLogCategoryName& Category, ELogVerbosity::Type Verbosity, const TCHAR* Fmt, ...)
{
#if !NO_LOGGING
	if (LIKELY(Verbosity != ELogVerbosity::Fatal))
	{
		// SetColour is routed to GWarn just like the other verbosities and handled in the
		// device that does the actual printing.
		FOutputDevice* LogOverride = nullptr;
		switch (Verbosity)
		{
		case ELogVerbosity::Error:
		case ELogVerbosity::Warning:
		case ELogVerbosity::Display:
		case ELogVerbosity::SetColor:
			LogOverride = GWarn;
			break;
		default:
			break;
		}
		GROWABLE_LOGF(LogOverride	? LogOverride->Log(Category, Verbosity, Buffer)
									: GLog->RedirectLog(Category, Verbosity, Buffer))
		if (Verbosity == ELogVerbosity::Error) {
			UBreakPoint::OnLogError();
		}
	}
	else
	{
		va_list Args;
		va_start(Args, Fmt);
		StaticFailDebugV(TEXT("Fatal error:"), "", File, Line, /*bIsEnsure*/ false, PLATFORM_RETURN_ADDRESS(), Fmt, Args);
		va_end(Args);
		va_start(Args, Fmt);
		FDebug::AssertFailedV("", File, Line, Fmt, Args);
		va_end(Args);
	}
#endif
}

void FMsg::LogV(const ANSICHAR* File, int32 Line, const FLogCategoryName& Category, ELogVerbosity::Type Verbosity, const TCHAR* Fmt, va_list Args)
{
#if !NO_LOGGING
	LLM_SCOPE_BYNAME("EngineMisc/FMsgLogf")
	QUICK_SCOPE_CYCLE_COUNTER(STAT_FMsgLogf);
	CSV_CUSTOM_STAT(FMsgLogf, FMsgLogfCount, 1, ECsvCustomStatOp::Accumulate);

	if (LIKELY(Verbosity != ELogVerbosity::Fatal))
	{
		TStringBuilder<512> Buffer;
		Buffer.AppendV(Fmt, Args);
		const TCHAR* Message = *Buffer;
		FOutputDevice* OutputDevice = nullptr;
		switch (Verbosity)
		{
		case ELogVerbosity::Error:
		case ELogVerbosity::Warning:
		case ELogVerbosity::Display:
		case ELogVerbosity::SetColor:
			OutputDevice = GWarn;
			break;
		default:
			break;
		}

		// Logging is always done in the open as we want logs even with transactionalized code.
		AutoRTFM::Open([OutputDevice, Message, Verbosity, Category]
		{
			(OutputDevice ? OutputDevice : GLog)->Serialize(Message, Verbosity, Category);
		});
		if (Verbosity == ELogVerbosity::Error) {
			UBreakPoint::OnLogError();
		}
	}
	else
	{
		StaticFailDebugV(TEXT("Fatal error:"), "", File, Line, /*bIsEnsure*/ false, PLATFORM_RETURN_ADDRESS(), Fmt, Args);
	}
#endif
}

void FMsg::Logf_InternalImpl(const ANSICHAR* File, int32 Line, const FLogCategoryName& Category, ELogVerbosity::Type Verbosity, const TCHAR* Fmt, ...)
{
#if !NO_LOGGING
	va_list Args;
	va_start(Args, Fmt);
	LogV(File, Line, Category, Verbosity, Fmt, Args);
	va_end(Args);
#endif
}

/** Sends a formatted message to a remote tool. */
void VARARGS FMsg::SendNotificationStringfImpl( const TCHAR *Fmt, ... )
{
	GROWABLE_LOGF(SendNotificationString(Buffer));
}

void FMsg::SendNotificationString( const TCHAR* Message )
{
	FPlatformMisc::LowLevelOutputDebugString(Message);
}