LibCarnaException.hpp

Go to the documentation of this file.

/*
 *  Copyright (C) 2010 - 2016 Leonid Kostrykin
 *
 *  Chair of Medical Engineering (mediTEC)
 *  RWTH Aachen University
 *  Pauwelsstr. 20
 *  52074 Aachen
 *  Germany
 * 
 * 
 *  Copyright (C) 2021 - 2025 Leonid Kostrykin
 * 
 */
 
#ifndef LIBCARNAEXCEPTION_H_6014714286
#define LIBCARNAEXCEPTION_H_6014714286
 
#include <memory>
#include <LibCarna/LibCarna.hpp>
#include <string>
#include <sstream>
#include <stdexcept>
#include <csignal>
 
namespace LibCarna
{
 
namespace base
{
 
 
 
// ----------------------------------------------------------------------------------
// LibCarnaException
// ----------------------------------------------------------------------------------
 
class LIBCARNA LibCarnaException
{
 
    struct Details;
    const std::unique_ptr< Details > pimpl;
 
public:
 
    LibCarnaException( const std::string& type, const std::string& message, const std::string& details = "" );
    
    LibCarnaException( const std::logic_error& error, const std::string& details = "" );
    
    LibCarnaException( const std::runtime_error& error, const std::string& details = "" );
 
    LibCarnaException( const LibCarnaException& other );
 
    virtual ~LibCarnaException();
 
 
    const std::string type;
 
    const std::string message;
    
    const std::string details;
 
 
    const char* what() const;
 
}; // LibCarnaException
 
 
 
// ----------------------------------------------------------------------------------
// AssertionFailure
// ----------------------------------------------------------------------------------
 
class LIBCARNA AssertionFailure : public LibCarnaException
{
 
public:
 
    explicit AssertionFailure( const std::string& details );
 
}; // AssertionFailure
 
 
 
// ----------------------------------------------------------------------------------
// BreakForDebug
// ----------------------------------------------------------------------------------
 
class LIBCARNA BreakForDebug
{
 
    BreakForDebug();
 
    static bool enabled;
 
public:
 
    static void enable();
    
    static void disable();
    
    static bool isEnabled();
 
}; // BreakForDebug
 
 
 
// ----------------------------------------------------------------------------------
// LIBCARNA_BREAK_FOR_DEBUG
// ----------------------------------------------------------------------------------
 
#ifndef NDEBUG
    #ifdef _MSC_VER
        #define LIBCARNA_BREAK_FOR_DEBUG \
            if( ::LibCarna::base::BreakForDebug::isEnabled() ) \
            { \
                __debugbreak(); \
            }
    #else
        #define LIBCARNA_BREAK_FOR_DEBUG \
            if( ::LibCarna::base::BreakForDebug::isEnabled() ) \
            { \
                std::raise( SIGINT ); \
            }
    #endif
#else
    #define LIBCARNA_BREAK_FOR_DEBUG
#endif
 
 
 
// ----------------------------------------------------------------------------------
// LIBCARNA_FAIL
// ----------------------------------------------------------------------------------
 
#define LIBCARNA_FAIL( description ) \
    LIBCARNA_BREAK_FOR_DEBUG \
    { \
        std::stringstream details; \
        details \
            << "Description: " << description << std::endl \
            << "Where: " << __FILE__ << ":" << __LINE__; \
        throw ::LibCarna::base::AssertionFailure( details.str() ); \
    }
 
 
 
// ----------------------------------------------------------------------------------
// LIBCARNA_ASSERT
// ----------------------------------------------------------------------------------
 
#define LIBCARNA_ASSERT( expression ) \
    if( !( expression ) ) \
    { \
        LIBCARNA_BREAK_FOR_DEBUG \
        std::stringstream details; \
        details \
            << "Failed expression: " << #expression << std::endl \
            << "Where: " << __FILE__ << ":" << __LINE__; \
        throw ::LibCarna::base::AssertionFailure( details.str() ); \
    }
 
 
 
// ----------------------------------------------------------------------------------
// LIBCARNA_ASSERT_EX
// ----------------------------------------------------------------------------------
 
#define LIBCARNA_ASSERT_EX( expression, description ) \
    if( !( expression ) ) \
    { \
        LIBCARNA_BREAK_FOR_DEBUG \
        std::stringstream details; \
        details \
            << "Failed expression: " << #expression << std::endl \
            << "Description: " << description << std::endl \
            << "Where: " << __FILE__ << ":" << __LINE__; \
        throw ::LibCarna::base::AssertionFailure( details.str() ); \
    }
 
 
 
}  // namespace LibCarna :: base
 
}  // namespace LibCarna
 
#endif // LIBCARNAEXCEPTION_H_6014714286