posix_code.hpp 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. /* Proposed SG14 status_code
  2. (C) 2018-2021 Niall Douglas <http://www.nedproductions.biz/> (5 commits)
  3. File Created: Feb 2018
  4. Boost Software License - Version 1.0 - August 17th, 2003
  5. Permission is hereby granted, free of charge, to any person or organization
  6. obtaining a copy of the software and accompanying documentation covered by
  7. this license (the "Software") to use, reproduce, display, distribute,
  8. execute, and transmit the Software, and to prepare derivative works of the
  9. Software, and to permit third-parties to whom the Software is furnished to
  10. do so, all subject to the following:
  11. The copyright notices in the Software and this entire statement, including
  12. the above license grant, this restriction and the following disclaimer,
  13. must be included in all copies of the Software, in whole or in part, and
  14. all derivative works of the Software, unless such copies or derivative
  15. works are solely in the form of machine-executable object code generated by
  16. a source language processor.
  17. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19. FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
  20. SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
  21. FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
  22. ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23. DEALINGS IN THE SOFTWARE.
  24. */
  25. #ifndef BOOST_OUTCOME_SYSTEM_ERROR2_POSIX_CODE_HPP
  26. #define BOOST_OUTCOME_SYSTEM_ERROR2_POSIX_CODE_HPP
  27. #ifdef BOOST_OUTCOME_SYSTEM_ERROR2_NOT_POSIX
  28. #error <posix_code.hpp> is not includable when BOOST_OUTCOME_SYSTEM_ERROR2_NOT_POSIX is defined!
  29. #endif
  30. #include "quick_status_code_from_enum.hpp"
  31. #include <cstring> // for strchr and strerror_r
  32. BOOST_OUTCOME_SYSTEM_ERROR2_NAMESPACE_BEGIN
  33. class _posix_code_domain;
  34. //! A POSIX error code, those returned by `errno`.
  35. using posix_code = status_code<_posix_code_domain>;
  36. //! A specialisation of `status_error` for the POSIX error code domain.
  37. using posix_error = status_error<_posix_code_domain>;
  38. namespace mixins
  39. {
  40. template <class Base> struct mixin<Base, _posix_code_domain> : public Base
  41. {
  42. using Base::Base;
  43. //! Returns a `posix_code` for the current value of `errno`.
  44. static posix_code current() noexcept;
  45. };
  46. } // namespace mixins
  47. /*! The implementation of the domain for POSIX error codes, those returned by `errno`.
  48. */
  49. class _posix_code_domain : public status_code_domain
  50. {
  51. template <class DomainType> friend class status_code;
  52. template <class StatusCode> friend class detail::indirecting_domain;
  53. using _base = status_code_domain;
  54. static _base::string_ref _make_string_ref(int c) noexcept
  55. {
  56. char buffer[1024] = "";
  57. #ifdef _WIN32
  58. strerror_s(buffer, sizeof(buffer), c);
  59. #elif defined(__gnu_linux__) && !defined(__ANDROID__) // handle glibc's weird strerror_r()
  60. char *s = strerror_r(c, buffer, sizeof(buffer)); // NOLINT
  61. if(s != nullptr)
  62. {
  63. strncpy(buffer, s, sizeof(buffer)); // NOLINT
  64. buffer[1023] = 0;
  65. }
  66. #else
  67. strerror_r(c, buffer, sizeof(buffer));
  68. #endif
  69. size_t length = strlen(buffer); // NOLINT
  70. auto *p = static_cast<char *>(malloc(length + 1)); // NOLINT
  71. if(p == nullptr)
  72. {
  73. return _base::string_ref("failed to get message from system");
  74. }
  75. memcpy(p, buffer, length + 1); // NOLINT
  76. return _base::atomic_refcounted_string_ref(p, length);
  77. }
  78. public:
  79. //! The value type of the POSIX code, which is an `int`
  80. using value_type = int;
  81. using _base::string_ref;
  82. //! Default constructor
  83. constexpr explicit _posix_code_domain(typename _base::unique_id_type id = 0xa59a56fe5f310933) noexcept
  84. : _base(id)
  85. {
  86. }
  87. _posix_code_domain(const _posix_code_domain &) = default;
  88. _posix_code_domain(_posix_code_domain &&) = default;
  89. _posix_code_domain &operator=(const _posix_code_domain &) = default;
  90. _posix_code_domain &operator=(_posix_code_domain &&) = default;
  91. ~_posix_code_domain() = default;
  92. //! Constexpr singleton getter. Returns constexpr posix_code_domain variable.
  93. static inline constexpr const _posix_code_domain &get();
  94. virtual string_ref name() const noexcept override { return string_ref("posix domain"); } // NOLINT
  95. protected:
  96. virtual bool _do_failure(const status_code<void> &code) const noexcept override // NOLINT
  97. {
  98. assert(code.domain() == *this); // NOLINT
  99. return static_cast<const posix_code &>(code).value() != 0; // NOLINT
  100. }
  101. virtual bool _do_equivalent(const status_code<void> &code1, const status_code<void> &code2) const noexcept override // NOLINT
  102. {
  103. assert(code1.domain() == *this); // NOLINT
  104. const auto &c1 = static_cast<const posix_code &>(code1); // NOLINT
  105. if(code2.domain() == *this)
  106. {
  107. const auto &c2 = static_cast<const posix_code &>(code2); // NOLINT
  108. return c1.value() == c2.value();
  109. }
  110. if(code2.domain() == generic_code_domain)
  111. {
  112. const auto &c2 = static_cast<const generic_code &>(code2); // NOLINT
  113. if(static_cast<int>(c2.value()) == c1.value())
  114. {
  115. return true;
  116. }
  117. }
  118. return false;
  119. }
  120. virtual generic_code _generic_code(const status_code<void> &code) const noexcept override // NOLINT
  121. {
  122. assert(code.domain() == *this); // NOLINT
  123. const auto &c = static_cast<const posix_code &>(code); // NOLINT
  124. return generic_code(static_cast<errc>(c.value()));
  125. }
  126. virtual string_ref _do_message(const status_code<void> &code) const noexcept override // NOLINT
  127. {
  128. assert(code.domain() == *this); // NOLINT
  129. const auto &c = static_cast<const posix_code &>(code); // NOLINT
  130. return _make_string_ref(c.value());
  131. }
  132. #if defined(_CPPUNWIND) || defined(__EXCEPTIONS) || defined(BOOST_OUTCOME_STANDARDESE_IS_IN_THE_HOUSE)
  133. BOOST_OUTCOME_SYSTEM_ERROR2_NORETURN virtual void _do_throw_exception(const status_code<void> &code) const override // NOLINT
  134. {
  135. assert(code.domain() == *this); // NOLINT
  136. const auto &c = static_cast<const posix_code &>(code); // NOLINT
  137. throw status_error<_posix_code_domain>(c);
  138. }
  139. #endif
  140. };
  141. //! A constexpr source variable for the POSIX code domain, which is that of `errno`. Returned by `_posix_code_domain::get()`.
  142. constexpr _posix_code_domain posix_code_domain;
  143. inline constexpr const _posix_code_domain &_posix_code_domain::get()
  144. {
  145. return posix_code_domain;
  146. }
  147. namespace mixins
  148. {
  149. template <class Base> inline posix_code mixin<Base, _posix_code_domain>::current() noexcept { return posix_code(errno); }
  150. } // namespace mixins
  151. BOOST_OUTCOME_SYSTEM_ERROR2_NAMESPACE_END
  152. #endif