mirror of
https://git.intern.spaceteamaachen.de/ALPAKA/sta-core.git
synced 2025-06-10 16:55:58 +00:00
145 lines
3.2 KiB
C++
145 lines
3.2 KiB
C++
/**
|
|
* @file
|
|
* @brief Assertion handling.
|
|
*
|
|
* Configuration:
|
|
* * STA_ASSERT_FORCE: Ignore debug defines and always enable assertions
|
|
* * DEBUG: Enables assertions when defined
|
|
* * NDEBUG: Disables assertions when defined (overrides DEBUG)
|
|
*/
|
|
#ifndef STA_CORE_ASSERT_HPP
|
|
#define STA_CORE_ASSERT_HPP
|
|
|
|
/**
|
|
* @defgroup staCore Core
|
|
* @brief STA Core library
|
|
*/
|
|
|
|
/**
|
|
* @defgroup staCoreBuildConfig Build Config
|
|
* @ingroup staCore
|
|
* @brief Build configuration options
|
|
*/
|
|
|
|
/**
|
|
* @defgroup staCoreAssert Assert
|
|
* @ingroup staCore
|
|
* @brief Assertion handling.
|
|
*/
|
|
|
|
|
|
#include <sta/config.hpp>
|
|
|
|
// Determine if module should be enabled
|
|
// Condition:
|
|
// STA_ASSERT_FORCE is defined
|
|
// or
|
|
// DEBUG is defined but not NDEBUG
|
|
#ifdef STA_ASSERT_FORCE
|
|
# define STA_ASSERT_ENABLED
|
|
#else // !STA_ASSERT_FORCE
|
|
# if defined(DEBUG) && !defined(NDEBUG)
|
|
# define STA_ASSERT_ENABLED
|
|
# endif // DEBUG && !NDEBUG
|
|
#endif // !STA_ASSERT_FORCE
|
|
|
|
|
|
#if defined(STA_ASSERT_ENABLED) || defined(DOXYGEN)
|
|
|
|
#include <cstdint>
|
|
|
|
|
|
namespace sta
|
|
{
|
|
/**
|
|
* @brief Handle failed assertions.
|
|
*
|
|
* The default implementation uses **STA_DEBUG_PRINT** and will not
|
|
* generate any output if the **DEBUG_SERIAL** module is disabled.
|
|
*
|
|
* Weak implementation can be overridden.
|
|
*
|
|
* @param expr Asserted expression or message
|
|
* @param file File name
|
|
* @param line Line number
|
|
*
|
|
* @ingroup staCoreAssert
|
|
*/
|
|
void assert_failed(const char * expr, const char * file, uint32_t line);
|
|
|
|
/**
|
|
* @brief Stop execution.
|
|
*
|
|
* Weak implementation can be overridden.
|
|
*
|
|
* @ingroup staCoreAssert
|
|
*/
|
|
void assert_halt();
|
|
} // namespace sta
|
|
|
|
|
|
/**
|
|
* @def STA_HALT
|
|
* @brief Set function called after failed asserts.
|
|
*
|
|
* @ingroup staCoreBuildConfig
|
|
*/
|
|
# ifndef STA_HALT
|
|
# define STA_HALT() sta::assert_halt()
|
|
# endif // !STA_HALT
|
|
|
|
|
|
/**
|
|
* @brief Assert expression.
|
|
*
|
|
* @param expr Expression
|
|
*
|
|
* @ingroup staCoreAssert
|
|
*/
|
|
# define STA_ASSERT(expr) ( (void)( !(expr) && ( sta::assert_failed(#expr, __FILE__, __LINE__), 1 ) && ( STA_HALT(), 1 ) ) )
|
|
/**
|
|
* @brief Assert expression.
|
|
*
|
|
* @param expr Expression
|
|
* @param msg Message shown on failure
|
|
*
|
|
* @ingroup staCoreAssert
|
|
*/
|
|
# define STA_ASSERT_MSG(expr, msg) ( (void)( !(expr) && ( sta::assert_failed(msg, __FILE__, __LINE__), 1 ) && ( STA_HALT(), 1 ) ) )
|
|
/**
|
|
* @brief Assert expression if condition is true.
|
|
*
|
|
* @param cond Condition
|
|
* @param expr Expression
|
|
*
|
|
* @ingroup staCoreAssert
|
|
*/
|
|
# define STA_ASSERT_COND(cond, expr) ( (void)( (cond) ? STA_ASSERT(expr) : 1 ) )
|
|
/**
|
|
* @brief Assert expression if condition is true.
|
|
*
|
|
* @param cond Condition
|
|
* @param expr Expression
|
|
* @param msg Message shown on failure
|
|
*
|
|
* @ingroup staCoreAssert
|
|
*/
|
|
# define STA_ASSERT_COND_MSG(cond, expr, msg) ( (void)( (cond) ? STA_ASSERT_MSG(expr, msg) ) )
|
|
|
|
|
|
# define STA_ASSERT_EXTRA(expr) expr;
|
|
|
|
#else // !STA_ASSERT_ENABLED
|
|
|
|
# define STA_ASSERT(expr) ((void)0)
|
|
# define STA_ASSERT_MSG(expr, msg) ((void)0)
|
|
# define STA_ASSERT_COND(cond, expr) ((void)0)
|
|
# define STA_ASSERT_COND_MSG(cond, expr, msg) ((void)0)
|
|
|
|
# define STA_ASSERT_EXTRA(expr) ((void)0)
|
|
|
|
#endif // !STA_ASSERT_ENABLED
|
|
|
|
|
|
#endif // STA_CORE_ASSERT_HPP
|