#ifndef NAVLIB_ERROR_H_INCLUDED_
#define NAVLIB_ERROR_H_INCLUDED_
// <copyright file="navlib_error.h" company="3Dconnexion">
// -------------------------------------------------------------------------------------------------
// Copyright (c) 2014-2021 3Dconnexion. All rights reserved.
//
// This file and source code are an integral part of the "3Dconnexion Software Developer Kit",
// including all accompanying documentation, and is protected by intellectual property laws. All use
// of the 3Dconnexion Software Developer Kit is subject to the License Agreement found in the
// "LicenseAgreementSDK.txt" file. All rights not expressly granted by 3Dconnexion are reserved.
// -------------------------------------------------------------------------------------------------
// </copyright>
// <history>
// *************************************************************************************************
// File History
//
// $Id: navlib_error.h 19940 2023-01-25 07:17:44Z mbonk $
//
// 01/23/14 MSB Initial design
// </history>
// <description>
// *************************************************************************************************
// File Description
//
// This header file defines the classes used for error reporting.
//
// *************************************************************************************************
// </description>

#include <system_error>

#include <navlib/navlib_types.h>


namespace std {
template <> struct is_error_code_enum<NAVLIB_ navlib_errc::navlib_errc_t> : true_type {};
} // namespace std

namespace { // Anonymous namespace
/// <summary>
/// Navigation library error category.
/// </summary>
struct navlib_error_category : public std::error_category {
  typedef std::error_category base_type;

public:
  navlib_error_category() NOEXCEPT {
  }

  const char *name() const NOEXCEPT override {
    return "navlib";
  }

  std::string message(int errorValue) const override {
    namespace navlib_errc = navlib::navlib_errc;
    switch (static_cast<navlib_errc::navlib_errc_t>(errorValue)) {
    case navlib_errc::property_not_found:
      return "Cannot locate the requested navlib property.";

    case navlib_errc::invalid_function:
      return "The requested function is not valid.";

    case navlib_errc::insufficient_buffer:
      return "Insufficient buffer space.";

    default:
      return std::generic_category().message(errorValue);
    }
  }
};

/// <summary>
/// Navigation library error category.
/// </summary>
static const navlib_error_category navlib_category;
} // namespace

NAVLIB_BEGIN_
/// <summary>
/// Makes a <see cref="std::error_code"/>.
/// </summary>
/// <param name="errc">The Navigation library error.</param>
/// <returns>A <see cref="std::error_code"/> with the Navigation library category.</returns>
inline std::error_code make_error_code(navlib_errc::navlib_errc_t errc) {
  std::error_code ec(static_cast<int>(errc), navlib_category);
  return ec;
}
NAVLIB_END_ // namespace navlib
#endif /* NAVLIB_ERROR_H_INCLUDED_ */
