assert_str.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************************/
 
#pragma once
 
//! \file assert_str.h
//! \brief Provides string-based assertion functionality for error handling
 
#include "vreUtil/export.h"
#include "vreUtil/assert.h"
 
#include <string>
 
namespace makVre
{
//! \brief Custom assertion function that supports string-based error messages
//!
//! This function provides a mechanism for runtime assertions with detailed string messages.
//! It evaluates the condition and, if false, triggers appropriate error handling.
//!
//! \param condition The boolean condition to evaluate
//! \param file The source file where the assertion occurred
//! \param function The function name where the assertion occurred
//! \param line The line number where the assertion occurred
//! \param expression The string representation of the expression being evaluated
//! \param message The detailed error message explaining the assertion failure
//! \param handled Pointer to boolean that will be set to true if the assertion was handled
//! \return false if the assertion failed, true otherwise
UTIL_DLL bool customAssert(bool condition, const char* file, const std::string& function, int line,
   const char* expression, const char* message, bool* handled);
} // namespace makVre