RuntimeErrors.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "HAL/PlatformMisc.h"
#include "Logging/LogVerbosity.h"
#include "Misc/AssertionMacros.h"
#include "Misc/Build.h"
#include "Misc/CoreDelegates.h"
 
class FText;
 
// By default we bubble up runtime errors to the editor or log under the same circumstances as we assert with check/ensure
#if !defined(UE_RAISE_RUNTIME_ERRORS)
#define UE_RAISE_RUNTIME_ERRORS DO_CHECK
#endif
 
struct FRuntimeErrors
{
    static CORE_API void LogRuntimeIssue(ELogVerbosity::Type Verbosity, const ANSICHAR* FileName, int32 LineNumber, const FText& Message);
 
    // The style of delegate called when a runtime issue occurs
    DECLARE_DELEGATE_FourParams(FRuntimeErrorDelegate, ELogVerbosity::Type /*Verbosity*/, const ANSICHAR* /*File*/, int32 /*Line*/, const FText& /*Message*/);
 
    // A delegate this is called when a runtime issue is raised
    static CORE_API FRuntimeErrorDelegate OnRuntimeIssueLogged;
 
    static CORE_API bool LogRuntimeIssueReturningFalse(const ANSICHAR* Expr, const ANSICHAR* File, int32 Line);
 
private:
    FRuntimeErrors() {}
};
 
#if UE_RAISE_RUNTIME_ERRORS && !USING_CODE_ANALYSIS
    // Raises a runtime error to the log, possibly stopping in the BP debugger, but then returning execution to the caller
    #define LogRuntimeError(Message) FRuntimeErrors::LogRuntimeIssue(ELogVerbosity::Error, __FILE__, __LINE__, Message)
 
    // Raises a runtime warning to the log, possibly stopping in the BP debugger, but then returning execution to the caller
    #define LogRuntimeWarning(Message) FRuntimeErrors::LogRuntimeIssue(ELogVerbosity::Warning, __FILE__, __LINE__, Message)
 
    #define ensureAsRuntimeWarning(InExpression) (LIKELY(!!(InExpression)) || FRuntimeErrors::LogRuntimeIssueReturningFalse(#InExpression, __FILE__, __LINE__))
#else
    #define LogRuntimeError(Message)
    #define LogRuntimeWarning(Message)
    #define ensureAsRuntimeWarning(InExpression) (!!(InExpression))
 
#endif