UT_ErrorCode.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_ErrorCode.h
 *
 * COMMENTS: A wrapper around std::error_code and std::error_category.
 *                      
 *
 */

#ifndef __UT_ERRORCODE_H__
#define __UT_ERRORCODE_H__

#include "UT_API.h"

#include <system_error>

using UT_ErrorCode = std::error_code;
using UT_ErrorCondition = std::error_condition;
using UT_ErrorCategory = std::error_category;

class UT_StringHolder;

/// Make a UT_ErrorCode based on the provided namespaced enum class.
template <typename EnumT>
auto
UTmakeErrorCode(EnumT e) -> decltype(make_error_code(e))
{
    if constexpr (!std::is_same<EnumT, std::errc>::value)
    {
        static_assert(
            std::is_error_code_enum<EnumT>::value,
            "Enum must be an error code enum.");
    }
    return make_error_code(e);
}

/// Helper method to log an error code.
UT_API void UTlogErrorCode(const UT_ErrorCode& ec, const UT_StringHolder& what);

#endif // __UT_ERRORCODE_H__