assert.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************************/
 
#pragma once
 
//! \file assert.h
//! \brief Provides assertion macros and functions for error detection and handling
 
#include "vreUtil/export.h"
 
#ifdef _WIN32
   #include "intrin.h"
#endif
 
 
namespace makVre
{
#ifdef _WIN32
   //! \brief Platform-specific debugger break instruction for Windows
   #define ASSERT_BREAK __debugbreak();
#else
   //! \brief Platform-specific debugger break instruction for non-Windows platforms
   #define ASSERT_BREAK asm("int $3");
#endif
 
//! \brief Custom assertion function that evaluates conditions and handles failures
//!
//! \param condition The boolean condition to evaluate
//! \param expression The string representation of the expression being evaluated
//! \param description The error description message
//! \param line The line number where the assertion occurred
//! \param file The source file where the assertion occurred
//! \param function The function name where the assertion occurred
//! \param handled Pointer to boolean that will be set to true if the assertion was handled
//! \return true if the debugger should break, false otherwise
UTIL_DLL bool customAssert(bool condition, const char* expression, const char* description, int line, const char* file,
   const char* function, bool* handled);
 
 
//! \brief Primary assertion macro for runtime validation
//!
//! This macro takes an expression that evaluates to true/false and a text description.
//! If the expression evaluates to false, this will show an assertion dialog (on Windows)
//! or output a console message (on Linux) with options to Abort, Retry, or Ignore.
//! - Abort: breaks into the debugger
//! - Retry: continues running, but the assertion will fire again if the expression evaluates to false again
//! - Ignore: suppresses this assertion and continues running
//!
//! \param exp The expression to evaluate
//! \param description Descriptive message about the assertion condition
#define DtASSERT(exp, description)                                                                                     \
   {                                                                                                                   \
      static bool ignoreAlways = false;                                                                                \
      if (!ignoreAlways)                                                                                               \
      {                                                                                                                \
         if (makVre::customAssert(bool(exp), #exp, description, __LINE__, __FILE__, __FUNCTION__, &ignoreAlways))      \
         {                                                                                                             \
            ASSERT_BREAK;                                                                                              \
         }                                                                                                             \
      }                                                                                                                \
   }
 
#if !defined(NIGHTLYBUILD)
//! \brief Development-only assertion macro
//!
//! Similar to DtASSERT but only active in development builds.
//! This assertion is disabled in nightly builds to avoid disrupting automated testing.
//!
//! \param exp The expression to evaluate
//! \param description Descriptive message about the assertion condition
   #define DtDEV_ASSERT(exp, description)                                                                              \
      {                                                                                                                \
         static bool ignoreAlways = false;                                                                             \
         if (!ignoreAlways)                                                                                            \
         {                                                                                                             \
            if (makVre::customAssert(bool(exp), #exp, description, __LINE__, __FILE__, __FUNCTION__, &ignoreAlways))   \
            {                                                                                                          \
               ASSERT_BREAK;                                                                                           \
            }                                                                                                          \
         }                                                                                                             \
      }
#else
 
   //! \brief No-op version of DtDEV_ASSERT for nightly builds
   #define DtDEV_ASSERT(exp, description)
 
#endif
 
} // namespace makVre