debug.h

Go to the documentation of this file.

 
#ifndef HERMES_LOG_DEBUG_H
#define HERMES_LOG_DEBUG_H
 
#include <hermes/common/defs.h>
#include <hermes/logging/logging.h>
#include <cmath>
#include <iostream>
#include <sstream>
 
#ifndef HERMES_DEBUG
#define HERMES_DEBUG
#endif
 
#ifndef CHECKS_ENABLED
#define CHECKS_ENABLED
#endif
 
#ifndef ASSERTIONS_ENABLED
#define ASSERTIONS_ENABLED
#endif
 
// *********************************************************************************************************************
//                                                                                                              UTILS
// *********************************************************************************************************************
// *********************************************************************************************************************
//                                                                                               COMPILATION WARNINGS
// *********************************************************************************************************************
#ifndef HERMES_UNUSED_VARIABLE
#define HERMES_UNUSED_VARIABLE(x) ((void)x);
#endif
 
#ifndef HERMES_NOT_IMPLEMENTED
#define HERMES_NOT_IMPLEMENTED \
  printf("[%s][%d][%s] calling not implemented function.", __FILE__, __LINE__, __FUNCTION__);
#endif
// *********************************************************************************************************************
//                                                                                                         DEBUG MODE
// *********************************************************************************************************************
#ifdef HERMES_DEBUG
#define HERMES_DEBUG_CODE(CODE_CONTENT) {CODE_CONTENT}
#else
#define HERMES_DEBUG_CODE(CODE_CONTENT)
#endif
 
// *********************************************************************************************************************
//                                                                                                             CHECKS
// *********************************************************************************************************************
#ifdef CHECKS_ENABLED
 
#define HERMES_CHECK_EQUAL(A, B)                                                                                    \
 if(A == B) {}                                                                                                      \
 else {                                                                                                             \
    hermes::Log::warn("[{}][{}][CHECK_EQUAL FAIL {} == {}] {} != {}", __FILE__, __LINE__, (#A), (#B), A, B);        \
 }
 
#define HERMES_CHECK_EXP(expr)                                                                                      \
  if(expr) {}                                                                                                       \
  else {                                                                                                            \
    hermes::Log::warn("[{}][{}][CHECK_EXP FAIL {}]", __FILE__, __LINE__, (#expr));                                  \
  }
 
#define HERMES_CHECK_EXP_WITH_LOG(expr, M)                                                                          \
  if(expr) {}                                                                                                       \
  else {                                                                                                            \
    hermes::Log::warn("[{}][{}][CHECK_EXP FAIL {}]: {}", __FILE__, __LINE__, (#expr), M);                           \
  }
#else
 
#define HERMES_CHECK_EXP(expr)
#define HERMES_CHECK_EXP_WITH_LOG(expr, M)
 
#endif // CHECKS_ENABLED
// *********************************************************************************************************************
//                                                                                                          ASSERTION
// *********************************************************************************************************************
#ifdef ASSERTIONS_ENABLED
 
//#define debugBreak() asm ("int 3")
#define debugBreak() exit(-1)
 
#define HERMES_ASSERT(expr)                                                                                         \
  if(expr) {}                                                                                                       \
  else {                                                                                                            \
    hermes::Log::error("[{}][{}][ASSERT FAIL {}]", __FILE__, __LINE__, #expr);                                      \
    debugBreak();                                                                                                   \
  }
#define HERMES_ASSERT_WITH_LOG(expr, M)                                                                             \
  if(expr) {}                                                                                                       \
  else {                                                                                                            \
    hermes::Log::error("[{}][{}][ASSERT FAIL {}]: {}", __FILE__, __LINE__, #expr, M);                               \
    debugBreak();                                                                                                   \
  }
#else
 
#define HERMES_ASSERT(expr)
#define HERMES_ASSERT_WITH_LOG(expr, M)
 
#endif // ASSERTIONS_ENABLED
// *********************************************************************************************************************
//                                                                                                          CODE FLOW
// *********************************************************************************************************************
#define HERMES_RETURN_IF(A)                                                                                         \
  if (A) {                                                                                                          \
    return;                                                                                                         \
  }
#define HERMES_RETURN_IF_NOT(A)                                                                                     \
  if (!(A)) {                                                                                                       \
    return;                                                                                                         \
  }
#define HERMES_RETURN_VALUE_IF(A, R)                                                                                \
  if (A) {                                                                                                          \
    return R;                                                                                                       \
  }
#define HERMES_RETURN_VALUE_IF_NOT(A, R)                                                                            \
  if (!(A)) {                                                                                                       \
    return R;                                                                                                       \
  }
#define HERMES_LOG_AND_RETURN_VALUE_IF_NOT(A, R, M)                                                                 \
  if (!(A)) {                                                                                                       \
    HERMES_LOG(M);                                                                                                  \
    return R;                                                                                                       \
  }
#define HERMES_LOG_AND_RETURN_IF_NOT(A, M)                                                                          \
  if (!(A)) {                                                                                                       \
    HERMES_LOG(M);                                                                                                  \
    return;                                                                                                         \
  }
 
#endif