Assert.h

#pragma once
 
#ifndef PL_INCLUDING_BASICS_H
#  error "Please don't include Assert.h directly, but instead include Foundation/Basics.h"
#endif
 
 
 
class plFormatString;
 
using plAssertHandler = bool (*)(const char* szSourceFile, plUInt32 uiLine, const char* szFunction, const char* szExpression, const char* szAssertMsg);
 
PL_FOUNDATION_DLL bool plDefaultAssertHandler(const char* szSourceFile, plUInt32 uiLine, const char* szFunction, const char* szExpression, const char* szAssertMsg);
 
PL_FOUNDATION_DLL plAssertHandler plGetAssertHandler();
 
PL_FOUNDATION_DLL void plSetAssertHandler(plAssertHandler handler);
 
PL_FOUNDATION_DLL bool plFailedCheck(const char* szSourceFile, plUInt32 uiLine, const char* szFunction, const char* szExpression, const class plFormatString& msg);
PL_FOUNDATION_DLL bool plFailedCheck(const char* szSourceFile, plUInt32 uiLine, const char* szFunction, const char* szExpression, const char* szMsg);
 
inline const char* plFmt(const char* szFormat)
{
  return szFormat;
}
 
#if PL_ENABLED(PL_COMPILER_MSVC)
// Hides the call to __debugbreak from MSVCs optimizer to work around a bug in VS 2019
// that can lead to code (memcpy) after an assert to be omitted
PL_FOUNDATION_DLL void MSVC_OutOfLine_DebugBreak(...);
#endif
 
#ifdef BUILDSYSTEM_CLANG_TIDY
[[noreturn]] void ClangTidyDoNotReturn();
#  define PL_REPORT_FAILURE(szErrorMsg, ...) ClangTidyDoNotReturn()
#else
#  define PL_REPORT_FAILURE(szErrorMsg, ...)                                                                       \
    do                                                                                                             \
    {                                                                                                              \
      if (plFailedCheck(PL_SOURCE_FILE, PL_SOURCE_LINE, PL_SOURCE_FUNCTION, "", plFmt(szErrorMsg, ##__VA_ARGS__))) \
        PL_DEBUG_BREAK;                                                                                            \
    } while (false)
#endif
 
#ifdef BUILDSYSTEM_CLANG_TIDY
#  define PL_ASSERT_ALWAYS(bCondition, szErrorMsg, ...) \
    do                                                  \
    {                                                   \
      if (!!(bCondition) == false)                      \
        ClangTidyDoNotReturn();                         \
    } while (false)
 
#  define PL_ANALYSIS_ASSUME(bCondition) PL_ASSERT_ALWAYS(bCondition, "")
#else
#  define PL_ASSERT_ALWAYS(bCondition, szErrorMsg, ...)                                                                       \
    do                                                                                                                        \
    {                                                                                                                         \
      PL_MSVC_ANALYSIS_WARNING_PUSH                                                                                           \
      PL_MSVC_ANALYSIS_WARNING_DISABLE(6326) /* disable static analysis for the comparison */                                 \
      if (!!(bCondition) == false)                                                                                            \
      {                                                                                                                       \
        if (plFailedCheck(PL_SOURCE_FILE, PL_SOURCE_LINE, PL_SOURCE_FUNCTION, #bCondition, plFmt(szErrorMsg, ##__VA_ARGS__))) \
          PL_DEBUG_BREAK;                                                                                                     \
      }                                                                                                                       \
      PL_MSVC_ANALYSIS_WARNING_POP                                                                                            \
    } while (false)
 
#  define PL_ANALYSIS_ASSUME(bCondition)
#endif
 
#define PL_ASSERT_NOT_IMPLEMENTED PL_REPORT_FAILURE("Not implemented");
 
// Occurrences of PL_ASSERT_DEBUG are compiled out in non-debug builds
#if PL_ENABLED(PL_COMPILE_FOR_DEBUG)
#  define PL_ASSERT_DEBUG PL_ASSERT_ALWAYS
#else
#  define PL_ASSERT_DEBUG(bCondition, szErrorMsg, ...)
#endif
 
 
// Occurrences of PL_ASSERT_DEV are compiled out in non-development builds
#if PL_ENABLED(PL_COMPILE_FOR_DEVELOPMENT) || PL_ENABLED(PL_COMPILE_FOR_DEBUG)
 
#  define PL_ASSERT_DEV PL_ASSERT_ALWAYS
 
#  define PL_VERIFY PL_ASSERT_ALWAYS
 
#else
 
#  define PL_ASSERT_DEV(bCondition, szErrorMsg, ...)
 
#  define PL_VERIFY(bCondition, szErrorMsg, ...)                             \
    if (!!(bCondition) == false)                                             \
    { /* The condition is evaluated, even though nothing is done with it. */ \
    }
 
#endif
 
#if PL_DISABLE_RELEASE_ASSERTS
 
#  define PL_ASSERT_RELEASE(bCondition, szErrorMsg, ...)
 
#else
 
#  define PL_ASSERT_RELEASE PL_ASSERT_ALWAYS
 
#endif
 
#define PL_DEFAULT_CASE_NOT_IMPLEMENTED \
  default:                              \
    PL_ASSERT_NOT_IMPLEMENTED           \
    break;