experimental/status-code/system_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_SYSTEM_CODE_HPP
0032 #define BOOST_OUTCOME_SYSTEM_ERROR2_SYSTEM_CODE_HPP
0033
0034 #ifndef BOOST_OUTCOME_SYSTEM_ERROR2_NOT_POSIX
0035 #include "posix_code.hpp"
0036 #else
0037 #include "quick_status_code_from_enum.hpp"
0038 #endif
0039
0040 #if defined(_WIN32) || defined(BOOST_OUTCOME_STANDARDESE_IS_IN_THE_HOUSE)
0041 #include "nt_code.hpp"
0042 #include "win32_code.hpp"
0043 // NOT "com_code.hpp"
0044 #endif
0045
0046 BOOST_OUTCOME_SYSTEM_ERROR2_NAMESPACE_BEGIN
0047 /*! An erased-mutable status code suitably large for all the system codes
0048 which can be returned on this system.
0049
0050 For Windows, these might be:
0051
0052     - `com_code` (`HRESULT`)  [you need to include "com_code.hpp" explicitly for this]
0053     - `nt_code` (`LONG`)
0054     - `win32_code` (`DWORD`)
0055
0056 For POSIX, `posix_code` is possible.
0057
0058 You are guaranteed that `system_code` can be transported by the compiler
0059 in exactly two CPU registers.
0060 */
0061 using system_code = erased_status_code<intptr_t>;
0062
0063 #ifndef NDEBUG
0064 static_assert(sizeof(system_code) == 2 * sizeof(void *), "system_code is not exactly two pointers in size!");
0065 static_assert(traits::is_move_bitcopying<system_code>::value, "system_code is not move bitcopying!");
0066 #endif
0067
0068 BOOST_OUTCOME_SYSTEM_ERROR2_NAMESPACE_END
0069
0070 #endif