/* Essentially an internal optional implementation :)
(C) 2017-2019 Niall Douglas (24 commits)
File Created: June 2017
Boost Software License - Version 1.0 - August 17th, 2003
Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:
The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
#ifndef BOOST_OUTCOME_VALUE_STORAGE_HPP
#define BOOST_OUTCOME_VALUE_STORAGE_HPP
#include "../config.hpp"
BOOST_OUTCOME_V2_NAMESPACE_BEGIN
namespace detail
{
template struct strong_swap_impl
{
constexpr strong_swap_impl(bool &allgood, T &a, T &b)
{
allgood = true;
using std::swap;
swap(a, b);
}
};
#ifndef BOOST_NO_EXCEPTIONS
template struct strong_swap_impl
{
strong_swap_impl(bool &allgood, T &a, T &b)
{
allgood = true;
T v(static_cast(a));
try
{
a = static_cast(b);
}
catch(...)
{
// Try to put back a
try
{
a = static_cast(v);
// fall through as all good
}
catch(...)
{
// failed to completely restore
allgood = false;
// throw away second exception
}
throw; // rethrow original exception
}
// b has been moved to a, try to move v to b
try
{
b = static_cast(v);
}
catch(...)
{
// Try to restore a to b, and v to a
try
{
b = static_cast(a);
a = static_cast(v);
// fall through as all good
}
catch(...)
{
// failed to completely restore
allgood = false;
// throw away second exception
}
throw; // rethrow original exception
}
}
};
#endif
} // namespace detail
/*!
*/
BOOST_OUTCOME_TEMPLATE(class T)
BOOST_OUTCOME_TREQUIRES(BOOST_OUTCOME_TPRED(std::is_move_constructible::value &&std::is_move_assignable::value))
constexpr inline void strong_swap(bool &allgood, T &a, T &b) noexcept(detail::is_nothrow_swappable::value)
{
detail::strong_swap_impl::value>(allgood, a, b);
}
namespace detail
{
using status_bitfield_type = uint32_t;
// WARNING: These bits are not tracked by abi-dumper, but changing them will break ABI!
static constexpr status_bitfield_type status_have_value = (1U << 0U);
static constexpr status_bitfield_type status_have_error = (1U << 1U);
static constexpr status_bitfield_type status_have_exception = (1U << 2U);
static constexpr status_bitfield_type status_lost_consistency = (1U << 3U); // failed to complete a strong swap
static constexpr status_bitfield_type status_error_is_errno = (1U << 4U); // can errno be set from this error?
// bit 7 unused
// bits 8-15 unused
// bits 16-31 used for user supplied 16 bit value
static constexpr status_bitfield_type status_2byte_shift = 16;
static constexpr status_bitfield_type status_2byte_mask = (0xffffU << status_2byte_shift);
// Used if T is trivial
template struct value_storage_trivial
{
using value_type = T;
union {
empty_type _empty;
devoid _value;
};
status_bitfield_type _status{0};
constexpr value_storage_trivial() noexcept
: _empty{}
{
}
// Special from-void catchall constructor, always constructs default T irrespective of whether void is valued or not (can do no better if T cannot be copied)
struct disable_void_catchall
{
};
using void_value_storage_trivial = std::conditional_t::value, disable_void_catchall, value_storage_trivial>;
explicit constexpr value_storage_trivial(const void_value_storage_trivial &o) noexcept(std::is_nothrow_default_constructible::value)
: _value()
, _status(o._status)
{
}
value_storage_trivial(const value_storage_trivial &) = default; // NOLINT
value_storage_trivial(value_storage_trivial &&) = default; // NOLINT
value_storage_trivial &operator=(const value_storage_trivial &) = default; // NOLINT
value_storage_trivial &operator=(value_storage_trivial &&) = default; // NOLINT
~value_storage_trivial() = default;
constexpr explicit value_storage_trivial(status_bitfield_type status)
: _empty()
, _status(status)
{
}
template
constexpr explicit value_storage_trivial(in_place_type_t /*unused*/, Args &&... args) noexcept(std::is_nothrow_constructible::value)
: _value(static_cast(args)...)
, _status(status_have_value)
{
}
template
constexpr value_storage_trivial(in_place_type_t /*unused*/, std::initializer_list il, Args &&... args) noexcept(std::is_nothrow_constructible, Args...>::value)
: _value(il, static_cast(args)...)
, _status(status_have_value)
{
}
template static constexpr bool enable_converting_constructor = !std::is_same, value_type>::value && std::is_constructible::value;
BOOST_OUTCOME_TEMPLATE(class U)
BOOST_OUTCOME_TREQUIRES(BOOST_OUTCOME_TPRED(enable_converting_constructor))
constexpr explicit value_storage_trivial(const value_storage_trivial &o) noexcept(std::is_nothrow_constructible::value)
: value_storage_trivial(((o._status & status_have_value) != 0) ? value_storage_trivial(in_place_type, o._value) : value_storage_trivial()) // NOLINT
{
_status = o._status;
}
BOOST_OUTCOME_TEMPLATE(class U)
BOOST_OUTCOME_TREQUIRES(BOOST_OUTCOME_TPRED(enable_converting_constructor))
constexpr explicit value_storage_trivial(value_storage_trivial &&o) noexcept(std::is_nothrow_constructible::value)
: value_storage_trivial(((o._status & status_have_value) != 0) ? value_storage_trivial(in_place_type, static_cast(o._value)) : value_storage_trivial()) // NOLINT
{
_status = o._status;
}
constexpr void swap(value_storage_trivial &o) noexcept
{
// storage is trivial, so just use assignment
auto temp = static_cast(*this);
*this = static_cast(o);
o = static_cast(temp);
}
};
// Used if T is non-trivial
template struct value_storage_nontrivial
{
using value_type = T;
union {
empty_type _empty;
value_type _value;
};
status_bitfield_type _status{0};
value_storage_nontrivial() noexcept
: _empty{}
{
}
value_storage_nontrivial &operator=(const value_storage_nontrivial &) = default; // if reaches here, copy assignment is trivial
value_storage_nontrivial &operator=(value_storage_nontrivial &&) = default; // NOLINT if reaches here, move assignment is trivial
value_storage_nontrivial(value_storage_nontrivial &&o) noexcept(std::is_nothrow_move_constructible::value) // NOLINT
: _status(o._status)
{
if(this->_status & status_have_value)
{
this->_status &= ~status_have_value;
new(&_value) value_type(static_cast(o._value)); // NOLINT
_status = o._status;
}
}
value_storage_nontrivial(const value_storage_nontrivial &o) noexcept(std::is_nothrow_copy_constructible::value)
: _status(o._status)
{
if(this->_status & status_have_value)
{
this->_status &= ~status_have_value;
new(&_value) value_type(o._value); // NOLINT
_status = o._status;
}
}
// Special from-void constructor, constructs default T if void valued
explicit value_storage_nontrivial(const value_storage_trivial &o) noexcept(std::is_nothrow_default_constructible::value)
: _status(o._status)
{
if(this->_status & status_have_value)
{
this->_status &= ~status_have_value;
new(&_value) value_type; // NOLINT
_status = o._status;
}
}
explicit value_storage_nontrivial(status_bitfield_type status)
: _empty()
, _status(status)
{
}
template
explicit value_storage_nontrivial(in_place_type_t /*unused*/, Args &&... args) noexcept(std::is_nothrow_constructible::value)
: _value(static_cast(args)...) // NOLINT
, _status(status_have_value)
{
}
template
value_storage_nontrivial(in_place_type_t /*unused*/, std::initializer_list il, Args &&... args) noexcept(std::is_nothrow_constructible, Args...>::value)
: _value(il, static_cast(args)...)
, _status(status_have_value)
{
}
template static constexpr bool enable_converting_constructor = !std::is_same, value_type>::value && std::is_constructible::value;
BOOST_OUTCOME_TEMPLATE(class U)
BOOST_OUTCOME_TREQUIRES(BOOST_OUTCOME_TPRED(enable_converting_constructor))
constexpr explicit value_storage_nontrivial(const value_storage_nontrivial &o) noexcept(std::is_nothrow_constructible::value)
: value_storage_nontrivial((o._status & status_have_value) != 0 ? value_storage_nontrivial(in_place_type, o._value) : value_storage_nontrivial())
{
_status = o._status;
}
BOOST_OUTCOME_TEMPLATE(class U)
BOOST_OUTCOME_TREQUIRES(BOOST_OUTCOME_TPRED(enable_converting_constructor))
constexpr explicit value_storage_nontrivial(const value_storage_trivial &o) noexcept(std::is_nothrow_constructible::value)
: value_storage_nontrivial((o._status & status_have_value) != 0 ? value_storage_nontrivial(in_place_type, o._value) : value_storage_nontrivial())
{
_status = o._status;
}
BOOST_OUTCOME_TEMPLATE(class U)
BOOST_OUTCOME_TREQUIRES(BOOST_OUTCOME_TPRED(enable_converting_constructor))
constexpr explicit value_storage_nontrivial(value_storage_nontrivial &&o) noexcept(std::is_nothrow_constructible::value)
: value_storage_nontrivial((o._status & status_have_value) != 0 ? value_storage_nontrivial(in_place_type, static_cast(o._value)) : value_storage_nontrivial())
{
_status = o._status;
}
BOOST_OUTCOME_TEMPLATE(class U)
BOOST_OUTCOME_TREQUIRES(BOOST_OUTCOME_TPRED(enable_converting_constructor))
constexpr explicit value_storage_nontrivial(value_storage_trivial &&o) noexcept(std::is_nothrow_constructible::value)
: value_storage_nontrivial((o._status & status_have_value) != 0 ? value_storage_nontrivial(in_place_type, static_cast(o._value)) : value_storage_nontrivial())
{
_status = o._status;
}
~value_storage_nontrivial() noexcept(std::is_nothrow_destructible::value)
{
if(this->_status & status_have_value)
{
this->_value.~value_type(); // NOLINT
this->_status &= ~status_have_value;
}
}
constexpr void swap(value_storage_nontrivial &o) noexcept(detail::is_nothrow_swappable::value)
{
using std::swap;
if((_status & status_have_value) == 0 && (o._status & status_have_value) == 0)
{
swap(_status, o._status);
return;
}
if((_status & status_have_value) != 0 && (o._status & status_have_value) != 0)
{
struct _
{
unsigned &a, &b;
bool all_good{false};
~_()
{
if(!all_good)
{
// We lost one of the values
a |= status_lost_consistency;
b |= status_lost_consistency;
}
}
} _{_status, o._status};
strong_swap(_.all_good, _value, o._value);
swap(_status, o._status);
return;
}
// One must be empty and the other non-empty, so use move construction
if((_status & status_have_value) != 0)
{
// Move construct me into other
new(&o._value) value_type(static_cast(_value)); // NOLINT
this->_value.~value_type(); // NOLINT
swap(_status, o._status);
}
else
{
// Move construct other into me
new(&_value) value_type(static_cast(o._value)); // NOLINT
o._value.~value_type(); // NOLINT
swap(_status, o._status);
}
}
};
template struct value_storage_delete_copy_constructor : Base // NOLINT
{
using Base::Base;
using value_type = typename Base::value_type;
value_storage_delete_copy_constructor() = default;
value_storage_delete_copy_constructor(const value_storage_delete_copy_constructor &) = delete;
value_storage_delete_copy_constructor(value_storage_delete_copy_constructor &&) = default; // NOLINT
};
template struct value_storage_delete_copy_assignment : Base // NOLINT
{
using Base::Base;
using value_type = typename Base::value_type;
value_storage_delete_copy_assignment() = default;
value_storage_delete_copy_assignment(const value_storage_delete_copy_assignment &) = default;
value_storage_delete_copy_assignment(value_storage_delete_copy_assignment &&) = default; // NOLINT
value_storage_delete_copy_assignment &operator=(const value_storage_delete_copy_assignment &o) = delete;
value_storage_delete_copy_assignment &operator=(value_storage_delete_copy_assignment &&o) = default; // NOLINT
};
template struct value_storage_delete_move_assignment : Base // NOLINT
{
using Base::Base;
using value_type = typename Base::value_type;
value_storage_delete_move_assignment() = default;
value_storage_delete_move_assignment(const value_storage_delete_move_assignment &) = default;
value_storage_delete_move_assignment(value_storage_delete_move_assignment &&) = default; // NOLINT
value_storage_delete_move_assignment &operator=(const value_storage_delete_move_assignment &o) = default;
value_storage_delete_move_assignment &operator=(value_storage_delete_move_assignment &&o) = delete;
};
template struct value_storage_delete_move_constructor : Base // NOLINT
{
using Base::Base;
using value_type = typename Base::value_type;
value_storage_delete_move_constructor() = default;
value_storage_delete_move_constructor(const value_storage_delete_move_constructor &) = default;
value_storage_delete_move_constructor(value_storage_delete_move_constructor &&) = delete;
};
template struct value_storage_nontrivial_move_assignment : Base // NOLINT
{
using Base::Base;
using value_type = typename Base::value_type;
value_storage_nontrivial_move_assignment() = default;
value_storage_nontrivial_move_assignment(const value_storage_nontrivial_move_assignment &) = default;
value_storage_nontrivial_move_assignment(value_storage_nontrivial_move_assignment &&) = default; // NOLINT
value_storage_nontrivial_move_assignment &operator=(const value_storage_nontrivial_move_assignment &o) = default;
value_storage_nontrivial_move_assignment &operator=(value_storage_nontrivial_move_assignment &&o) noexcept(std::is_nothrow_move_assignable::value) // NOLINT
{
if((this->_status & status_have_value) != 0 && (o._status & status_have_value) != 0)
{
this->_value = static_cast(o._value); // NOLINT
}
else if((this->_status & status_have_value) != 0 && (o._status & status_have_value) == 0)
{
this->_value.~value_type(); // NOLINT
}
else if((this->_status & status_have_value) == 0 && (o._status & status_have_value) != 0)
{
new(&this->_value) value_type(static_cast(o._value)); // NOLINT
}
this->_status = o._status;
return *this;
}
};
template struct value_storage_nontrivial_copy_assignment : Base // NOLINT
{
using Base::Base;
using value_type = typename Base::value_type;
value_storage_nontrivial_copy_assignment() = default;
value_storage_nontrivial_copy_assignment(const value_storage_nontrivial_copy_assignment &) = default;
value_storage_nontrivial_copy_assignment(value_storage_nontrivial_copy_assignment &&) = default; // NOLINT
value_storage_nontrivial_copy_assignment &operator=(value_storage_nontrivial_copy_assignment &&o) = default; // NOLINT
value_storage_nontrivial_copy_assignment &operator=(const value_storage_nontrivial_copy_assignment &o) noexcept(std::is_nothrow_copy_assignable::value)
{
if((this->_status & status_have_value) != 0 && (o._status & status_have_value) != 0)
{
this->_value = o._value; // NOLINT
}
else if((this->_status & status_have_value) != 0 && (o._status & status_have_value) == 0)
{
this->_value.~value_type(); // NOLINT
}
else if((this->_status & status_have_value) == 0 && (o._status & status_have_value) != 0)
{
new(&this->_value) value_type(o._value); // NOLINT
}
this->_status = o._status;
return *this;
}
};
// We don't actually need all of std::is_trivial<>, std::is_trivially_copyable<> is sufficient
template using value_storage_select_trivality = std::conditional_t>::value, value_storage_trivial, value_storage_nontrivial>;
template using value_storage_select_move_constructor = std::conditional_t>::value, value_storage_select_trivality, value_storage_delete_move_constructor>>;
template using value_storage_select_copy_constructor = std::conditional_t>::value, value_storage_select_move_constructor, value_storage_delete_copy_constructor>>;
template
using value_storage_select_move_assignment = std::conditional_t>::value, value_storage_select_copy_constructor,
std::conditional_t>::value, value_storage_nontrivial_move_assignment>, value_storage_delete_copy_assignment>>>;
template
using value_storage_select_copy_assignment = std::conditional_t>::value, value_storage_select_move_assignment,
std::conditional_t>::value, value_storage_nontrivial_copy_assignment>, value_storage_delete_copy_assignment>>>;
template using value_storage_select_impl = value_storage_select_copy_assignment;
#ifndef NDEBUG
// Check is trivial in all ways except default constructibility
// static_assert(std::is_trivial>::value, "value_storage_select_impl is not trivial!");
// static_assert(std::is_trivially_default_constructible>::value, "value_storage_select_impl is not trivially default constructible!");
static_assert(std::is_trivially_copyable>::value, "value_storage_select_impl is not trivially copyable!");
static_assert(std::is_trivially_assignable, value_storage_select_impl>::value, "value_storage_select_impl is not trivially assignable!");
static_assert(std::is_trivially_destructible>::value, "value_storage_select_impl is not trivially destructible!");
static_assert(std::is_trivially_copy_constructible>::value, "value_storage_select_impl is not trivially copy constructible!");
static_assert(std::is_trivially_move_constructible>::value, "value_storage_select_impl is not trivially move constructible!");
static_assert(std::is_trivially_copy_assignable>::value, "value_storage_select_impl is not trivially copy assignable!");
static_assert(std::is_trivially_move_assignable>::value, "value_storage_select_impl is not trivially move assignable!");
// Also check is standard layout
static_assert(std::is_standard_layout>::value, "value_storage_select_impl is not a standard layout type!");
#endif
} // namespace detail
BOOST_OUTCOME_V2_NAMESPACE_END
#endif