errors.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2020-2023 Tilt Five, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
 
#include "errors.h"
 
#include <system_error>
 
namespace tiltfive {
 
//                                   Error                                   //
 
 
enum class Error {
    // --------- C Errors ---------
    kSuccess = T5_SUCCESS,
 
    kTimeout = T5_TIMEOUT,
 
    //
    kNoContext = T5_ERROR_NO_CONTEXT,
 
    kLibraryUnavailable = T5_ERROR_NO_LIBRARY,
 
    kInternalError = T5_ERROR_INTERNAL,
 
    kNoService = T5_ERROR_NO_SERVICE,
 
    kIoFailure = T5_ERROR_IO_FAILURE,
 
    kRequestIdUnknown = T5_ERROR_REQUEST_ID_UNKNOWN,
 
    kInvalidArgument = T5_ERROR_INVALID_ARGS,
 
    kDeviceLost = T5_ERROR_DEVICE_LOST,
 
    kTargetNotFound = T5_ERROR_TARGET_NOT_FOUND,
 
    kInvalidState = T5_ERROR_INVALID_STATE,
 
    kSettingUnknown = T5_ERROR_SETTING_UNKNOWN,
 
    kSettingWrongType = T5_ERROR_SETTING_WRONG_TYPE,
 
    kMiscRemote = T5_ERROR_MISC_REMOTE,
 
    kOverflow = T5_ERROR_OVERFLOW,
 
    kGfxApiUnavailable = T5_ERROR_GRAPHICS_API_UNAVAILABLE,
 
    kUnsupported = T5_ERROR_UNSUPPORTED,
 
    kDecodeError = T5_ERROR_DECODE_ERROR,
 
    kInvalidGfxContext = T5_ERROR_INVALID_GFX_CONTEXT,
 
    kGfxContextInitFail = T5_ERROR_GFX_CONTEXT_INIT_FAIL,
 
    kTryAgain = T5_ERROR_TRY_AGAIN,
 
    kUnavailable = T5_ERROR_UNAVAILABLE,
 
    kAlreadyConnected = T5_ERROR_ALREADY_CONNECTED,
 
    kNotConnected = T5_ERROR_NOT_CONNECTED,
 
    kStringOverflow = T5_ERROR_STRING_OVERFLOW,
 
    kServiceIncompatible = T5_ERROR_SERVICE_INCOMPATIBLE,
 
    kPermissionDenied = T5_PERMISSION_DENIED,
 
    kInvalidBuffer = T5_ERROR_INVALID_BUFFER_SIZE,
 
    kInvalidGeometry = T5_ERROR_INVALID_GEOMETRY,
};
 
 
namespace details {
 
// Work around the lack of inline variable support.
template <typename Dummy>
struct ErrorCategory : std::error_category {
    [[nodiscard]] auto name() const noexcept -> const char* override {
        return "Tilt Five Error";
    }
 
    [[nodiscard]] auto message(int ev) const -> std::string override {
        return ::t5GetResultMessage(static_cast<T5_Result>(ev));
    }
 
    static const ErrorCategory kSingleton;
};
 
template <typename Dummy>
const ErrorCategory<Dummy> ErrorCategory<Dummy>::kSingleton;
 
}  // namespace details
 
using ErrorCategory = details::ErrorCategory<void>;
 
inline std::error_code make_error_code(Error e) noexcept {
    return {static_cast<int>(e), ErrorCategory::kSingleton};
}
 
}  // namespace tiltfive
 
namespace std {
 
template <>
struct is_error_code_enum<tiltfive::Error> : true_type {};
 
}  // namespace std