boost/outcome/experimental/status-code/posix_code.hpp

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