error_code.h

Go to the documentation of this file.

 
#ifndef _ERROR_CODE_H_
#define _ERROR_CODE_H_
 
#include "log_global.h"
#include "meta.h"
#include "term.h"
#include <cassert>
#include <iostream>
#include <string>
#include <type_traits>
 
enum class Err : int {
    SUCCESS = 0,
    // error
    CLI_OPTIONS = 100,
    NO_GUI,
    INPUT_NOT_EXISTS,
    UNKOWN_CMD,
    OUTPUT_FILE_EXISTS,
    CANNOT_OPEN_OUTPUT_FILE,
    YAML_SYNTAX,
    YAML_DTYPE,
    VERSION_STRING_ERROR,
    TOO_MANY_TX,
    TOO_MANY_RX,
    ASTYLE_ERROR,
    COMPILE_ERROR,
    SIMULATE_ERROR,
    CONFIG_ERROR,
    CANNOT_COPY_FROM_INCLUDE,
    ALG_EXPORT_ESTIMATION,
    ALG_EXPORT_GEN_BF,
    ALG_EXPORT_ALGORITHM,
    // warning
    VERSION_NOT_SPECIFIED = 200,
};
 
static inline int errorCode(const Err& e) noexcept { return static_cast<int>(e); }
 
static inline std::string errorMsg(const Err& e) noexcept {
    switch (e) {
    case Err::SUCCESS: return "Success!";
    case Err::CLI_OPTIONS: return "Command line options error.";
    case Err::NO_GUI: return "No GUI App.";
    case Err::INPUT_NOT_EXISTS: return "Input file does not exist.";
    case Err::UNKOWN_CMD: return "Unknown command (use mmcesim -h for more information).";
    case Err::OUTPUT_FILE_EXISTS:
        return "Output file exists. To force overwriting, you can use option '--force' or '-f'.";
    case Err::CANNOT_OPEN_OUTPUT_FILE: return "Cannot open output file.";
    case Err::YAML_SYNTAX: return "YAML syntax error.";
    case Err::YAML_DTYPE: return "YAML data type error.";
    case Err::VERSION_STRING_ERROR: return "Invalid version string.";
    case Err::TOO_MANY_TX: return "Too many transmitters.";
    case Err::TOO_MANY_RX: return "Too many receivers.";
    case Err::ASTYLE_ERROR: return "Astyle formatting error.";
    case Err::COMPILE_ERROR: return "Simulation compilation error.";
    case Err::SIMULATE_ERROR: return "Simulation running error.";
    case Err::CONFIG_ERROR: return "Configuration error.";
    case Err::CANNOT_COPY_FROM_INCLUDE:
        return "Cannot copy from include directory. Please check if directory 'include/mmcesim/copy' exists.";
    case Err::ALG_EXPORT_ESTIMATION: return "ALG export estimation error.";
    case Err::ALG_EXPORT_GEN_BF: return "ALG export generation BF error.";
    case Err::ALG_EXPORT_ALGORITHM: return "ALG export algorithm error.";
    case Err::VERSION_NOT_SPECIFIED:
        return "Version string not specified. Assume as application version " + _MMCESIM_VER_STR + ".";
    default: return "Error!";
    }
}
 
static inline bool isError(const Err& e) noexcept { return errorCode(e) >= 100 && errorCode(e) < 200; }
 
static inline bool isWarning(const Err& e) noexcept { return errorCode(e) >= 200; }
 
static inline bool isSuccess(const Err& e) noexcept { return e == Err::SUCCESS; }
 
static inline void errorExit(const Err& e, bool show_error = true) noexcept {
    assert(isError(e) && "check if it is really an error in errorExit");
    if (show_error) {
        auto msg = errorMsg(e);
        Term::error(msg);
        _log.err() << msg << std::endl;
    }
    exit(errorCode(e));
}
 
#endif