Exception.hpp

/*
 * Copyright (C) 2021 CERN
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 *
 * Created on: 2021-11-17
 *     Author: Michal Mysior <mmysior> <michal.mysior@cern.ch>
 *
 */
 
#ifndef MOTION_CONTROLLER_EXCEPTION_HPP__
#define MOTION_CONTROLLER_EXCEPTION_HPP__
 
#include <cerrno>
#include <exception>
#include <system_error>
 
namespace smc {
enum class ErrorCode
{
    Ok = 0,
    InvalidArguments = EINVAL, /*< invalid argument */
    IO = EIO,                  /*< io error */
    Canceled = ECANCELED,      /*< operation aborted */
    Runtime = EFAULT,          /*< runtime error */
    NotSupported = ENOTSUP,    /*< Operation not supported */
 
    InternalError = 1000, /*< internal error */
    IncompatibleUnits,    /*< incompatible units */
};
 
class Exception : public std::exception
{
public:
    Exception() = delete;
    explicit Exception(std::error_code ev);
    Exception(std::error_code ev, const std::string &what);
 
    inline const std::error_code getErrorCode() const noexcept
    {
        return m_errorCode;
    }
 
    const char *what() const noexcept override;
 
private:
    const std::error_code m_errorCode;
    mutable std::string m_what;
};
 
std::error_code make_error_code(smc::ErrorCode);
 
Exception make_errno_exception(std::error_code ev);
 
} /* namespace smc */
 
namespace std {
 
template<>
struct is_error_code_enum<smc::ErrorCode> : true_type
{};
 
} /* namespace std */
 
#endif /* MOTION_CONTROLLER_EXCEPTION_HPP__ */