experimental/status-code/com_code.hpp

0001 /* Proposed SG14 status_code
0002 (C) 2018-2024 Niall Douglas <http://www.nedproductions.biz/> (5 commits)
0003 File Created: Feb 2018
0004
0005
0006 Boost Software License - Version 1.0 - August 17th, 2003
0007
0008 Permission is hereby granted, free of charge, to any person or organization
0009 obtaining a copy of the software and accompanying documentation covered by
0010 this license (the "Software") to use, reproduce, display, distribute,
0011 execute, and transmit the Software, and to prepare derivative works of the
0012 Software, and to permit third-parties to whom the Software is furnished to
0013 do so, all subject to the following:
0014
0015 The copyright notices in the Software and this entire statement, including
0016 the above license grant, this restriction and the following disclaimer,
0017 must be included in all copies of the Software, in whole or in part, and
0018 all derivative works of the Software, unless such copies or derivative
0019 works are solely in the form of machine-executable object code generated by
0020 a source language processor.
0021
0022 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0023 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0024 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
0025 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
0026 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
0027 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
0028 DEALINGS IN THE SOFTWARE.
0029 */
0030
0031 #ifndef BOOST_OUTCOME_SYSTEM_ERROR2_COM_CODE_HPP
0032 #define BOOST_OUTCOME_SYSTEM_ERROR2_COM_CODE_HPP
0033
0034 #if !defined(_WIN32) && !defined(BOOST_OUTCOME_STANDARDESE_IS_IN_THE_HOUSE)
0035 #error This file should only be included on Windows
0036 #endif
0037
0038 #include "nt_code.hpp"
0039 #include "win32_code.hpp"
0040
0041 #ifndef BOOST_OUTCOME_STANDARDESE_IS_IN_THE_HOUSE
0042 #include <stdio.h>  // needed by mingw for comdef.h to work
0043
0044 #include <comdef.h>
0045 #endif
0046
0047 BOOST_OUTCOME_SYSTEM_ERROR2_NAMESPACE_BEGIN
0048
0049 class _com_code_domain;
0050 /*! (Windows only) A COM error code. Note semantic equivalence testing is only implemented for `FACILITY_WIN32`
0051 and `FACILITY_NT_BIT`. As you can see at
0052 [https://blogs.msdn.microsoft.com/eldar/2007/04/03/a-lot-of-hresult-codes/](https://blogs.msdn.microsoft.com/eldar/2007/04/03/a-lot-of-hresult-codes/), there
0053 are an awful lot of COM error codes, and keeping mapping tables for all of them would be impractical (for the Win32 and NT facilities, we actually reuse the
0054 mapping tables in `win32_code` and `nt_code`). You can, of course, inherit your own COM code domain from this one and override the `_do_equivalent()` function
0055 to add semantic equivalence testing for whichever extra COM codes that your application specifically needs.
0056 */
0057 using com_code = status_code<_com_code_domain>;
0058 //! (Windows only) A specialisation of `status_error` for the COM error code domain.
0059 using com_error = status_error<_com_code_domain>;
0060
0061 /*! (Windows only) The implementation of the domain for COM error codes and/or `IErrorInfo`.
0062  */
0063 class _com_code_domain : public status_code_domain
0064 {
0065   template <class DomainType> friend class status_code;
0066   using _base = status_code_domain;
0067
0068   //! Construct from a `HRESULT` error code
0069 #ifdef _COMDEF_NOT_WINAPI_FAMILY_DESKTOP_APP
0070   static _base::string_ref _make_string_ref(HRESULT c, wchar_t *perrinfo = nullptr) noexcept
0071 #else
0072   static _base::string_ref _make_string_ref(HRESULT c, IErrorInfo *perrinfo = nullptr) noexcept
0073 #endif
0074   {
0075     _com_error ce(c, perrinfo);
0076 #ifdef _UNICODE
0077     win32::DWORD wlen = (win32::DWORD) wcslen(ce.ErrorMessage());
0078     size_t allocation = wlen + (wlen >> 1);
0079     win32::DWORD bytes;
0080     if(wlen == 0)
0081     {
0082       return _base::string_ref("failed to get message from system");
0083     }
0084     for(;;)
0085     {
0086       auto *p = static_cast<char *>(malloc(allocation));  // NOLINT
0087       if(p == nullptr)
0088       {
0089         return _base::string_ref("failed to get message from system");
0090       }
0091       bytes = win32::WideCharToMultiByte(65001 /*CP_UTF8*/, 0, ce.ErrorMessage(), (int) (wlen + 1), p, (int) allocation, nullptr, nullptr);
0092       if(bytes != 0)
0093       {
0094         char *end = strchr(p, 0);
0095         while(end[-1] == 10 || end[-1] == 13)
0096         {
0097           --end;
0098         }
0099         *end = 0;  // NOLINT
0100         return _base::atomic_refcounted_string_ref(p, end - p);
0101       }
0102       free(p);  // NOLINT
0103       if(win32::GetLastError() == 0x7a /*ERROR_INSUFFICIENT_BUFFER*/)
0104       {
0105         allocation += allocation >> 2;
0106         continue;
0107       }
0108       return _base::string_ref("failed to get message from system");
0109     }
0110 #else
0111     auto wlen = static_cast<win32::DWORD>(strlen(ce.ErrorMessage()));
0112     auto *p = static_cast<char *>(malloc(wlen + 1));  // NOLINT
0113     if(p == nullptr)
0114     {
0115       return _base::string_ref("failed to get message from system");
0116     }
0117     memcpy(p, ce.ErrorMessage(), wlen + 1);
0118     char *end = strchr(p, 0);
0119     while(end[-1] == 10 || end[-1] == 13)
0120     {
0121       --end;
0122     }
0123     *end = 0;  // NOLINT
0124     return _base::atomic_refcounted_string_ref(p, end - p);
0125 #endif
0126   }
0127
0128 public:
0129   //! The value type of the COM code, which is a `HRESULT`
0130   using value_type = HRESULT;
0131   using _base::string_ref;
0132
0133 public:
0134   //! Default constructor
0135   constexpr explicit _com_code_domain(typename _base::unique_id_type id = 0xdc8275428b4effac) noexcept
0136       : _base(id)
0137   {
0138   }
0139   _com_code_domain(const _com_code_domain &) = default;
0140   _com_code_domain(_com_code_domain &&) = default;
0141   _com_code_domain &operator=(const _com_code_domain &) = default;
0142   _com_code_domain &operator=(_com_code_domain &&) = default;
0143   ~_com_code_domain() = default;
0144
0145   //! Constexpr singleton getter. Returns the constexpr com_code_domain variable.
0146   static inline constexpr const _com_code_domain &get();
0147
0148   virtual string_ref name() const noexcept override { return string_ref("COM domain"); }  // NOLINT
0149
0150   virtual payload_info_t payload_info() const noexcept override
0151   {
0152     return {sizeof(value_type), sizeof(status_code_domain *) + sizeof(value_type),
0153             (alignof(value_type) > alignof(status_code_domain *)) ? alignof(value_type) : alignof(status_code_domain *)};
0154   }
0155
0156 protected:
0157   virtual bool _do_failure(const status_code<void> &code) const noexcept override  // NOLINT
0158   {
0159     assert(code.domain() == *this);
0160     return static_cast<const com_code &>(code).value() < 0;  // NOLINT
0161   }
0162   /*! Note semantic equivalence testing is only implemented for `FACILITY_WIN32` and `FACILITY_NT_BIT`.
0163    */
0164   virtual bool _do_equivalent(const status_code<void> &code1, const status_code<void> &code2) const noexcept override  // NOLINT
0165   {
0166     assert(code1.domain() == *this);
0167     const auto &c1 = static_cast<const com_code &>(code1);  // NOLINT
0168     if(code2.domain() == *this)
0169     {
0170       const auto &c2 = static_cast<const com_code &>(code2);  // NOLINT
0171       return c1.value() == c2.value();
0172     }
0173     if((c1.value() & FACILITY_NT_BIT) != 0)
0174     {
0175       if(code2.domain() == nt_code_domain)
0176       {
0177         const auto &c2 = static_cast<const nt_code &>(code2);  // NOLINT
0178         if(c2.value() == (c1.value() & ~FACILITY_NT_BIT))
0179         {
0180           return true;
0181         }
0182       }
0183       else if(code2.domain() == generic_code_domain)
0184       {
0185         const auto &c2 = static_cast<const generic_code &>(code2);  // NOLINT
0186         if(static_cast<int>(c2.value()) == _nt_code_domain::_nt_code_to_errno(c1.value() & ~FACILITY_NT_BIT))
0187         {
0188           return true;
0189         }
0190       }
0191     }
0192     else if(HRESULT_FACILITY(c1.value()) == FACILITY_WIN32)
0193     {
0194       if(code2.domain() == win32_code_domain)
0195       {
0196         const auto &c2 = static_cast<const win32_code &>(code2);  // NOLINT
0197         if(c2.value() == HRESULT_CODE(c1.value()))
0198         {
0199           return true;
0200         }
0201       }
0202       else if(code2.domain() == generic_code_domain)
0203       {
0204         const auto &c2 = static_cast<const generic_code &>(code2);  // NOLINT
0205         if(static_cast<int>(c2.value()) == _win32_code_domain::_win32_code_to_errno(HRESULT_CODE(c1.value())))
0206         {
0207           return true;
0208         }
0209       }
0210     }
0211     return false;
0212   }
0213   virtual generic_code _generic_code(const status_code<void> &code) const noexcept override  // NOLINT
0214   {
0215     assert(code.domain() == *this);
0216     const auto &c1 = static_cast<const com_code &>(code);  // NOLINT
0217     if(c1.value() == S_OK)
0218     {
0219       return generic_code(errc::success);
0220     }
0221     if((c1.value() & FACILITY_NT_BIT) != 0)
0222     {
0223       return generic_code(static_cast<errc>(_nt_code_domain::_nt_code_to_errno(c1.value() & ~FACILITY_NT_BIT)));
0224     }
0225     if(HRESULT_FACILITY(c1.value()) == FACILITY_WIN32)
0226     {
0227       return generic_code(static_cast<errc>(_win32_code_domain::_win32_code_to_errno(HRESULT_CODE(c1.value()))));
0228     }
0229     return generic_code(errc::unknown);
0230   }
0231   virtual string_ref _do_message(const status_code<void> &code) const noexcept override  // NOLINT
0232   {
0233     assert(code.domain() == *this);
0234     const auto &c = static_cast<const com_code &>(code);  // NOLINT
0235     return _make_string_ref(c.value());
0236   }
0237 #if defined(_CPPUNWIND) || defined(__EXCEPTIONS) || defined(BOOST_OUTCOME_STANDARDESE_IS_IN_THE_HOUSE)
0238   BOOST_OUTCOME_SYSTEM_ERROR2_NORETURN virtual void _do_throw_exception(const status_code<void> &code) const override  // NOLINT
0239   {
0240     assert(code.domain() == *this);
0241     const auto &c = static_cast<const com_code &>(code);  // NOLINT
0242     throw status_error<_com_code_domain>(c);
0243   }
0244 #endif
0245 };
0246 //! (Windows only) A constexpr source variable for the COM code domain. Returned by `_com_code_domain::get()`.
0247 constexpr _com_code_domain com_code_domain;
0248 inline constexpr const _com_code_domain &_com_code_domain::get()
0249 {
0250   return com_code_domain;
0251 }
0252
0253 BOOST_OUTCOME_SYSTEM_ERROR2_NAMESPACE_END
0254
0255 #endif