CarnaException.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2010 - 2015 Leonid Kostrykin
 *
 *  Chair of Medical Engineering (mediTEC)
 *  RWTH Aachen University
 *  Pauwelsstr. 20
 *  52074 Aachen
 *  Germany
 *
 */

#ifndef CARNAEXCEPTION_H_6014714286
#define CARNAEXCEPTION_H_6014714286

#include <Carna/Carna.h>
#include <string>
#include <sstream>
#include <stdexcept>
#include <csignal>

namespace Carna
{

namespace base
{



// ----------------------------------------------------------------------------------
// CarnaException
// ----------------------------------------------------------------------------------

class CARNA_LIB CarnaException
{

public:

    CarnaException( const std::string& type, const std::string& message, const std::string& details = "" );
    
    CarnaException( const std::logic_error& error, const std::string& details = "" );
    
    CarnaException( const std::runtime_error& error, const std::string& details = "" );

    virtual ~CarnaException();


    const std::string type;

    const std::string message;
    
    const std::string details;

}; // CarnaException



// ----------------------------------------------------------------------------------
// AssertionFailure
// ----------------------------------------------------------------------------------

class CARNA_LIB AssertionFailure : public CarnaException
{

public:

    explicit AssertionFailure( const std::string& details );

}; // AssertionFailure



// ----------------------------------------------------------------------------------
// BreakForDebug
// ----------------------------------------------------------------------------------

class CARNA_LIB BreakForDebug
{

    BreakForDebug();

    static bool enabled;

public:

    static void enable();
    
    static void disable();
    
    static bool isEnabled();

}; // BreakForDebug



// ----------------------------------------------------------------------------------
// CARNA_BREAK_FOR_DEBUG
// ----------------------------------------------------------------------------------

#ifndef NDEBUG
    #ifdef _MSC_VER
        #define CARNA_BREAK_FOR_DEBUG \
            if( ::Carna::base::BreakForDebug::isEnabled() ) \
            { \
                __debugbreak(); \
            }
    #else
        #define CARNA_BREAK_FOR_DEBUG \
            if( ::Carna::base::BreakForDebug::isEnabled() ) \
            { \
                std::raise( SIGINT ); \
            }
    #endif
#else
    #define CARNA_BREAK_FOR_DEBUG
#endif



// ----------------------------------------------------------------------------------
// CARNA_FAIL
// ----------------------------------------------------------------------------------

#define CARNA_FAIL( description ) \
    CARNA_BREAK_FOR_DEBUG \
    { \
        std::stringstream details; \
        details \
            << "Description: " << description << std::endl \
            << "File: " << __FILE__ << std::endl \
            << "Line: " << __LINE__; \
        throw ::Carna::base::AssertionFailure( details.str() ); \
    }



// ----------------------------------------------------------------------------------
// CARNA_ASSERT
// ----------------------------------------------------------------------------------

#define CARNA_ASSERT( expression ) \
    if( !( expression ) ) \
    { \
        CARNA_BREAK_FOR_DEBUG \
        std::stringstream details; \
        details \
            << "Failed expression: " << #expression << std::endl \
            << "File: " << __FILE__ << std::endl \
            << "Line: " << __LINE__; \
        throw ::Carna::base::AssertionFailure( details.str() ); \
    }



// ----------------------------------------------------------------------------------
// CARNA_ASSERT_EX
// ----------------------------------------------------------------------------------

#define CARNA_ASSERT_EX( expression, description ) \
    if( !( expression ) ) \
    { \
        CARNA_BREAK_FOR_DEBUG \
        std::stringstream details; \
        details \
            << "Failed expression: " << #expression << std::endl \
            << "Description: " << description << std::endl \
            << "File: " << __FILE__ << std::endl \
            << "Line: " << __LINE__; \
        throw ::Carna::base::AssertionFailure( details.str() ); \
    }



}  // namespace Carna :: base

}  // namespace Carna

#endif // CARNAEXCEPTION_H_6014714286