UtilError.hpp

Go to the documentation of this file.

 
#ifndef __ERRORLOG_HXX__ /*-- allow multiple inclusions --*/
#define __ERRORLOG_HXX__ 
// Standard header files
#include <iomanip>
#include <iostream>
#include <sstream>
 
#define OCP_LOCATION                                                                   \
    "\n    --> function: " << __PRETTY_FUNCTION__                                      \
                           << "\n    --> file:     " << __FILE__ << "::" << __LINE__
 
//  msg: user-defined error message
//  We use do-while to allow the macro to be ended with ";"
#define OCP_MESSAGE(msg)                                                               \
    do {                                                                               \
        std::ostringstream info;                                                       \
        info << std::setprecision(16);                                                 \
        info << msg << OCP_LOCATION << '\n';                                           \
        std::cerr << info.str().c_str();                                               \
    } while (false)
 
//  msg: user-defined warning message
//  We use do-while to allow the macro to be ended with ";"
#define OCP_WARNING(msg)                                                               \
    do {                                                                               \
        OCP_MESSAGE("### WARNING: " << (msg));                                         \
    } while (false)
 
//  msg: user-defined abort message
//  We use do-while to allow the macro to be ended with ";"
#define OCP_ABORT(msg)                                                                 \
    do {                                                                               \
        OCP_MESSAGE("### ABORT: " << (msg));                                           \
        std::abort();                                                                  \
    } while (false)
 
//  cond: check condition
//  msg: user-defined error message
//  We use do-while to allow the macro to be ended with ";"
#ifndef DEBUG
#define OCP_ASSERT(cond, msg)                                                          \
    do {                                                                               \
    } while (false)
#else
#define OCP_ASSERT(cond, msg)                                                          \
    do {                                                                               \
        if (!(cond)) {                                                                 \
            OCP_MESSAGE("### ASSERT: " << (msg) << " (" << #cond << ")");              \
            std::abort();                                                              \
        }                                                                              \
    } while (false)
#endif
 
#ifndef OCPFUNCNAME
#define OCP_FUNCNAME                                                                   \
    do {                                                                               \
    } while (false)
#else
#define OCP_FUNCNAME                                                                   \
    do {                                                                               \
        std::cout << __FUNCTION__ << std::endl;                                        \
    } while (false)
#endif
 
#endif /* end if for __ERRORLOG_HXX__ */
 
/*----------------------------------------------------------------------------*/
/*  Brief Change History of This File                                         */
/*----------------------------------------------------------------------------*/
/*  Author              Date             Actions                              */
/*----------------------------------------------------------------------------*/
/*  Shizhe Li           Oct/01/2021      Create file                          */
/*  Chensong Zhang      Oct/15/2021      Format file                          */
/*  Chensong Zhang      Nov/15/2021      Test DEBUG mode                      */
/*----------------------------------------------------------------------------*/