1 // <optional> -*- C++ -*-
3 // Copyright (C) 2013-2024 Free Software Foundation, Inc.
4 // Copyright The GNU Toolchain Authors.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 3, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 // <http://www.gnu.org/licenses/>.
26 /** @file include/optional
27 * This is a Standard C++ Library header.
30 #ifndef _GLIBCXX_OPTIONAL
31 #define _GLIBCXX_OPTIONAL 1
33 #pragma GCC system_header
35 #define __glibcxx_want_freestanding_optional
36 #define __glibcxx_want_optional
37 #include <bits/version.h>
39 #ifdef __cpp_lib_optional // C++ >= 17
41 #include <type_traits>
44 #include <initializer_list>
45 #include <bits/enable_special_members.h>
46 #include <bits/exception_defines.h>
47 #include <bits/functional_hash.h>
48 #include <bits/stl_construct.h> // _Construct
49 #include <bits/utility.h> // in_place_t
50 #if __cplusplus > 201703L
52 # include <bits/invoke.h> // std::__invoke
54 #if __cplusplus > 202002L
58 namespace std _GLIBCXX_VISIBILITY(default)
60 _GLIBCXX_BEGIN_NAMESPACE_VERSION
63 * @addtogroup utilities
67 template<typename _Tp>
70 /// Tag type to disengage optional objects.
73 // Do not user-declare default constructor at all for
74 // optional_value = {} syntax to work.
75 // nullopt_t() = delete;
77 // Used for constructing nullopt.
78 enum class _Construct { _Token };
80 // Must be constexpr for nullopt_t to be literal.
81 explicit constexpr nullopt_t(_Construct) noexcept { }
84 /// Tag to disengage optional objects.
85 inline constexpr nullopt_t nullopt { nullopt_t::_Construct::_Token };
87 template<typename _Fn> struct _Optional_func { _Fn& _M_f; };
90 * @brief Exception class thrown when a disengaged optional object is
94 class bad_optional_access : public exception
97 bad_optional_access() = default;
98 virtual ~bad_optional_access() = default;
100 const char* what() const noexcept override
101 { return "bad optional access"; }
104 // XXX Does not belong here.
105 [[__noreturn__]] inline void
106 __throw_bad_optional_access()
107 { _GLIBCXX_THROW_OR_ABORT(bad_optional_access()); }
109 // This class template manages construction/destruction of
110 // the contained value for a std::optional.
111 template <typename _Tp>
112 struct _Optional_payload_base
114 using _Stored_type = remove_const_t<_Tp>;
116 _Optional_payload_base() = default;
117 ~_Optional_payload_base() = default;
119 template<typename... _Args>
121 _Optional_payload_base(in_place_t __tag, _Args&&... __args)
122 : _M_payload(__tag, std::forward<_Args>(__args)...),
126 template<typename _Up, typename... _Args>
128 _Optional_payload_base(std::initializer_list<_Up> __il,
130 : _M_payload(__il, std::forward<_Args>(__args)...),
134 // Constructor used by _Optional_base copy constructor when the
135 // contained value is not trivially copy constructible.
137 _Optional_payload_base(bool /* __engaged */,
138 const _Optional_payload_base& __other)
140 if (__other._M_engaged)
141 this->_M_construct(__other._M_get());
144 // Constructor used by _Optional_base move constructor when the
145 // contained value is not trivially move constructible.
147 _Optional_payload_base(bool /* __engaged */,
148 _Optional_payload_base&& __other)
150 if (__other._M_engaged)
151 this->_M_construct(std::move(__other._M_get()));
154 // Copy constructor is only used to when the contained value is
155 // trivially copy constructible.
156 _Optional_payload_base(const _Optional_payload_base&) = default;
158 // Move constructor is only used to when the contained value is
159 // trivially copy constructible.
160 _Optional_payload_base(_Optional_payload_base&&) = default;
162 _Optional_payload_base&
163 operator=(const _Optional_payload_base&) = default;
165 _Optional_payload_base&
166 operator=(_Optional_payload_base&&) = default;
168 // used to perform non-trivial copy assignment.
170 _M_copy_assign(const _Optional_payload_base& __other)
172 if (this->_M_engaged && __other._M_engaged)
173 this->_M_get() = __other._M_get();
176 if (__other._M_engaged)
177 this->_M_construct(__other._M_get());
183 // used to perform non-trivial move assignment.
185 _M_move_assign(_Optional_payload_base&& __other)
186 noexcept(__and_v<is_nothrow_move_constructible<_Tp>,
187 is_nothrow_move_assignable<_Tp>>)
189 if (this->_M_engaged && __other._M_engaged)
190 this->_M_get() = std::move(__other._M_get());
193 if (__other._M_engaged)
194 this->_M_construct(std::move(__other._M_get()));
200 struct _Empty_byte { };
202 template<typename _Up, bool = is_trivially_destructible_v<_Up>>
205 constexpr _Storage() noexcept : _M_empty() { }
207 template<typename... _Args>
209 _Storage(in_place_t, _Args&&... __args)
210 : _M_value(std::forward<_Args>(__args)...)
213 template<typename _Vp, typename... _Args>
215 _Storage(std::initializer_list<_Vp> __il, _Args&&... __args)
216 : _M_value(__il, std::forward<_Args>(__args)...)
219 #if __cplusplus >= 202002L
220 template<typename _Fn, typename _Arg>
222 _Storage(_Optional_func<_Fn> __f, _Arg&& __arg)
223 : _M_value(std::__invoke(std::forward<_Fn>(__f._M_f),
224 std::forward<_Arg>(__arg)))
228 _Empty_byte _M_empty;
232 template<typename _Up>
233 union _Storage<_Up, false>
235 constexpr _Storage() noexcept : _M_empty() { }
237 template<typename... _Args>
239 _Storage(in_place_t, _Args&&... __args)
240 : _M_value(std::forward<_Args>(__args)...)
243 template<typename _Vp, typename... _Args>
245 _Storage(std::initializer_list<_Vp> __il, _Args&&... __args)
246 : _M_value(__il, std::forward<_Args>(__args)...)
249 #if __cplusplus >= 202002L
250 template<typename _Fn, typename _Arg>
252 _Storage(_Optional_func<_Fn> __f, _Arg&& __arg)
253 : _M_value(std::__invoke(std::forward<_Fn>(__f._M_f),
254 std::forward<_Arg>(__arg)))
258 // User-provided destructor is needed when _Up has non-trivial dtor.
259 _GLIBCXX20_CONSTEXPR ~_Storage() { }
261 _Empty_byte _M_empty;
265 _Storage<_Stored_type> _M_payload;
267 bool _M_engaged = false;
269 template<typename... _Args>
271 _M_construct(_Args&&... __args)
272 noexcept(is_nothrow_constructible_v<_Stored_type, _Args...>)
274 std::_Construct(std::__addressof(this->_M_payload._M_value),
275 std::forward<_Args>(__args)...);
276 this->_M_engaged = true;
280 _M_destroy() noexcept
283 _M_payload._M_value.~_Stored_type();
286 #if __cplusplus >= 202002L
287 template<typename _Fn, typename _Up>
289 _M_apply(_Optional_func<_Fn> __f, _Up&& __x)
291 std::construct_at(std::__addressof(this->_M_payload),
292 __f, std::forward<_Up>(__x));
297 // The _M_get() operations have _M_engaged as a precondition.
298 // They exist to access the contained value with the appropriate
299 // const-qualification, because _M_payload has had the const removed.
303 { return this->_M_payload._M_value; }
306 _M_get() const noexcept
307 { return this->_M_payload._M_value; }
309 // _M_reset is a 'safe' operation with no precondition.
313 if (this->_M_engaged)
315 else // This seems redundant but improves codegen, see PR 112480.
316 this->_M_engaged = false;
320 // Class template that manages the payload for optionals.
321 template <typename _Tp,
322 bool /*_HasTrivialDestructor*/ =
323 is_trivially_destructible_v<_Tp>,
324 bool /*_HasTrivialCopy */ =
325 is_trivially_copy_assignable_v<_Tp>
326 && is_trivially_copy_constructible_v<_Tp>,
327 bool /*_HasTrivialMove */ =
328 is_trivially_move_assignable_v<_Tp>
329 && is_trivially_move_constructible_v<_Tp>>
330 struct _Optional_payload;
332 // Payload for potentially-constexpr optionals (trivial copy/move/destroy).
333 template <typename _Tp>
334 struct _Optional_payload<_Tp, true, true, true>
335 : _Optional_payload_base<_Tp>
337 using _Optional_payload_base<_Tp>::_Optional_payload_base;
339 _Optional_payload() = default;
342 // Payload for optionals with non-trivial copy construction/assignment.
343 template <typename _Tp>
344 struct _Optional_payload<_Tp, true, false, true>
345 : _Optional_payload_base<_Tp>
347 using _Optional_payload_base<_Tp>::_Optional_payload_base;
349 _Optional_payload() = default;
350 ~_Optional_payload() = default;
351 _Optional_payload(const _Optional_payload&) = default;
352 _Optional_payload(_Optional_payload&&) = default;
353 _Optional_payload& operator=(_Optional_payload&&) = default;
355 // Non-trivial copy assignment.
358 operator=(const _Optional_payload& __other)
360 this->_M_copy_assign(__other);
365 // Payload for optionals with non-trivial move construction/assignment.
366 template <typename _Tp>
367 struct _Optional_payload<_Tp, true, true, false>
368 : _Optional_payload_base<_Tp>
370 using _Optional_payload_base<_Tp>::_Optional_payload_base;
372 _Optional_payload() = default;
373 ~_Optional_payload() = default;
374 _Optional_payload(const _Optional_payload&) = default;
375 _Optional_payload(_Optional_payload&&) = default;
376 _Optional_payload& operator=(const _Optional_payload&) = default;
378 // Non-trivial move assignment.
381 operator=(_Optional_payload&& __other)
382 noexcept(__and_v<is_nothrow_move_constructible<_Tp>,
383 is_nothrow_move_assignable<_Tp>>)
385 this->_M_move_assign(std::move(__other));
390 // Payload for optionals with non-trivial copy and move assignment.
391 template <typename _Tp>
392 struct _Optional_payload<_Tp, true, false, false>
393 : _Optional_payload_base<_Tp>
395 using _Optional_payload_base<_Tp>::_Optional_payload_base;
397 _Optional_payload() = default;
398 ~_Optional_payload() = default;
399 _Optional_payload(const _Optional_payload&) = default;
400 _Optional_payload(_Optional_payload&&) = default;
402 // Non-trivial copy assignment.
405 operator=(const _Optional_payload& __other)
407 this->_M_copy_assign(__other);
411 // Non-trivial move assignment.
414 operator=(_Optional_payload&& __other)
415 noexcept(__and_v<is_nothrow_move_constructible<_Tp>,
416 is_nothrow_move_assignable<_Tp>>)
418 this->_M_move_assign(std::move(__other));
423 // Payload for optionals with non-trivial destructors.
424 template <typename _Tp, bool _Copy, bool _Move>
425 struct _Optional_payload<_Tp, false, _Copy, _Move>
426 : _Optional_payload<_Tp, true, false, false>
428 // Base class implements all the constructors and assignment operators:
429 using _Optional_payload<_Tp, true, false, false>::_Optional_payload;
430 _Optional_payload() = default;
431 _Optional_payload(const _Optional_payload&) = default;
432 _Optional_payload(_Optional_payload&&) = default;
433 _Optional_payload& operator=(const _Optional_payload&) = default;
434 _Optional_payload& operator=(_Optional_payload&&) = default;
436 // Destructor needs to destroy the contained value:
437 _GLIBCXX20_CONSTEXPR ~_Optional_payload() { this->_M_reset(); }
440 // Common base class for _Optional_base<T> to avoid repeating these
441 // member functions in each specialization.
442 template<typename _Tp, typename _Dp>
443 class _Optional_base_impl
446 using _Stored_type = remove_const_t<_Tp>;
448 // The _M_construct operation has !_M_engaged as a precondition
449 // while _M_destruct has _M_engaged as a precondition.
450 template<typename... _Args>
452 _M_construct(_Args&&... __args)
453 noexcept(is_nothrow_constructible_v<_Stored_type, _Args...>)
455 static_cast<_Dp*>(this)->_M_payload._M_construct(
456 std::forward<_Args>(__args)...);
460 _M_destruct() noexcept
461 { static_cast<_Dp*>(this)->_M_payload._M_destroy(); }
463 // _M_reset is a 'safe' operation with no precondition.
466 { static_cast<_Dp*>(this)->_M_payload._M_reset(); }
468 constexpr bool _M_is_engaged() const noexcept
469 { return static_cast<const _Dp*>(this)->_M_payload._M_engaged; }
471 // The _M_get operations have _M_engaged as a precondition.
475 __glibcxx_assert(this->_M_is_engaged());
476 return static_cast<_Dp*>(this)->_M_payload._M_get();
480 _M_get() const noexcept
482 __glibcxx_assert(this->_M_is_engaged());
483 return static_cast<const _Dp*>(this)->_M_payload._M_get();
488 * @brief Class template that provides copy/move constructors of optional.
490 * Such a separate base class template is necessary in order to
491 * conditionally make copy/move constructors trivial.
493 * When the contained value is trivially copy/move constructible,
494 * the copy/move constructors of _Optional_base will invoke the
495 * trivial copy/move constructor of _Optional_payload. Otherwise,
496 * they will invoke _Optional_payload(bool, const _Optional_payload&)
497 * or _Optional_payload(bool, _Optional_payload&&) to initialize
498 * the contained value, if copying/moving an engaged optional.
500 * Whether the other special members are trivial is determined by the
501 * _Optional_payload<_Tp> specialization used for the _M_payload member.
503 * @see optional, _Enable_special_members
505 template<typename _Tp,
506 bool = is_trivially_copy_constructible_v<_Tp>,
507 bool = is_trivially_move_constructible_v<_Tp>>
508 struct _Optional_base
509 : _Optional_base_impl<_Tp, _Optional_base<_Tp>>
511 // Constructors for disengaged optionals.
512 constexpr _Optional_base() = default;
514 // Constructors for engaged optionals.
515 template<typename... _Args,
516 enable_if_t<is_constructible_v<_Tp, _Args...>, bool> = false>
518 _Optional_base(in_place_t, _Args&&... __args)
519 : _M_payload(in_place, std::forward<_Args>(__args)...)
522 template<typename _Up, typename... _Args,
523 enable_if_t<is_constructible_v<_Tp,
524 initializer_list<_Up>&,
525 _Args...>, bool> = false>
527 _Optional_base(in_place_t,
528 initializer_list<_Up> __il,
530 : _M_payload(in_place, __il, std::forward<_Args>(__args)...)
533 // Copy and move constructors.
535 _Optional_base(const _Optional_base& __other)
536 : _M_payload(__other._M_payload._M_engaged, __other._M_payload)
540 _Optional_base(_Optional_base&& __other)
541 noexcept(is_nothrow_move_constructible_v<_Tp>)
542 : _M_payload(__other._M_payload._M_engaged,
543 std::move(__other._M_payload))
546 // Assignment operators.
547 _Optional_base& operator=(const _Optional_base&) = default;
548 _Optional_base& operator=(_Optional_base&&) = default;
550 _Optional_payload<_Tp> _M_payload;
553 template<typename _Tp>
554 struct _Optional_base<_Tp, false, true>
555 : _Optional_base_impl<_Tp, _Optional_base<_Tp>>
557 // Constructors for disengaged optionals.
558 constexpr _Optional_base() = default;
560 // Constructors for engaged optionals.
561 template<typename... _Args,
562 enable_if_t<is_constructible_v<_Tp, _Args...>, bool> = false>
564 _Optional_base(in_place_t, _Args&&... __args)
565 : _M_payload(in_place, std::forward<_Args>(__args)...)
568 template<typename _Up, typename... _Args,
569 enable_if_t<is_constructible_v<_Tp,
570 initializer_list<_Up>&,
571 _Args...>, bool> = false>
573 _Optional_base(in_place_t,
574 initializer_list<_Up> __il,
576 : _M_payload(in_place, __il, std::forward<_Args>(__args)...)
579 // Copy and move constructors.
580 constexpr _Optional_base(const _Optional_base& __other)
581 : _M_payload(__other._M_payload._M_engaged, __other._M_payload)
584 constexpr _Optional_base(_Optional_base&& __other) = default;
586 // Assignment operators.
587 _Optional_base& operator=(const _Optional_base&) = default;
588 _Optional_base& operator=(_Optional_base&&) = default;
590 _Optional_payload<_Tp> _M_payload;
593 template<typename _Tp>
594 struct _Optional_base<_Tp, true, false>
595 : _Optional_base_impl<_Tp, _Optional_base<_Tp>>
597 // Constructors for disengaged optionals.
598 constexpr _Optional_base() = default;
600 // Constructors for engaged optionals.
601 template<typename... _Args,
602 enable_if_t<is_constructible_v<_Tp, _Args...>, bool> = false>
604 _Optional_base(in_place_t, _Args&&... __args)
605 : _M_payload(in_place, std::forward<_Args>(__args)...)
608 template<typename _Up, typename... _Args,
609 enable_if_t<is_constructible_v<_Tp,
610 initializer_list<_Up>&,
611 _Args...>, bool> = false>
613 _Optional_base(in_place_t,
614 initializer_list<_Up> __il,
616 : _M_payload(in_place, __il, std::forward<_Args>(__args)...)
619 // Copy and move constructors.
620 constexpr _Optional_base(const _Optional_base& __other) = default;
623 _Optional_base(_Optional_base&& __other)
624 noexcept(is_nothrow_move_constructible_v<_Tp>)
625 : _M_payload(__other._M_payload._M_engaged,
626 std::move(__other._M_payload))
629 // Assignment operators.
630 _Optional_base& operator=(const _Optional_base&) = default;
631 _Optional_base& operator=(_Optional_base&&) = default;
633 _Optional_payload<_Tp> _M_payload;
636 template<typename _Tp>
637 struct _Optional_base<_Tp, true, true>
638 : _Optional_base_impl<_Tp, _Optional_base<_Tp>>
640 // Constructors for disengaged optionals.
641 constexpr _Optional_base() = default;
643 // Constructors for engaged optionals.
644 template<typename... _Args,
645 enable_if_t<is_constructible_v<_Tp, _Args...>, bool> = false>
647 _Optional_base(in_place_t, _Args&&... __args)
648 : _M_payload(in_place, std::forward<_Args>(__args)...)
651 template<typename _Up, typename... _Args,
652 enable_if_t<is_constructible_v<_Tp,
653 initializer_list<_Up>&,
654 _Args...>, bool> = false>
656 _Optional_base(in_place_t,
657 initializer_list<_Up> __il,
659 : _M_payload(in_place, __il, std::forward<_Args>(__args)...)
662 // Copy and move constructors.
663 constexpr _Optional_base(const _Optional_base& __other) = default;
664 constexpr _Optional_base(_Optional_base&& __other) = default;
666 // Assignment operators.
667 _Optional_base& operator=(const _Optional_base&) = default;
668 _Optional_base& operator=(_Optional_base&&) = default;
670 _Optional_payload<_Tp> _M_payload;
673 template<typename _Tp>
676 template<typename _Tp>
677 inline constexpr bool __is_optional_v = false;
678 template<typename _Tp>
679 inline constexpr bool __is_optional_v<optional<_Tp>> = true;
681 template<typename _Tp, typename _Up>
682 using __converts_from_optional =
683 __or_<is_constructible<_Tp, const optional<_Up>&>,
684 is_constructible<_Tp, optional<_Up>&>,
685 is_constructible<_Tp, const optional<_Up>&&>,
686 is_constructible<_Tp, optional<_Up>&&>,
687 is_convertible<const optional<_Up>&, _Tp>,
688 is_convertible<optional<_Up>&, _Tp>,
689 is_convertible<const optional<_Up>&&, _Tp>,
690 is_convertible<optional<_Up>&&, _Tp>>;
692 template<typename _Tp, typename _Up>
693 using __assigns_from_optional =
694 __or_<is_assignable<_Tp&, const optional<_Up>&>,
695 is_assignable<_Tp&, optional<_Up>&>,
696 is_assignable<_Tp&, const optional<_Up>&&>,
697 is_assignable<_Tp&, optional<_Up>&&>>;
700 * @brief Class template for optional values.
702 template<typename _Tp>
704 : private _Optional_base<_Tp>,
705 private _Enable_copy_move<
707 is_copy_constructible_v<_Tp>,
709 __and_v<is_copy_constructible<_Tp>, is_copy_assignable<_Tp>>,
711 is_move_constructible_v<_Tp>,
713 __and_v<is_move_constructible<_Tp>, is_move_assignable<_Tp>>,
717 static_assert(!is_same_v<remove_cv_t<_Tp>, nullopt_t>);
718 static_assert(!is_same_v<remove_cv_t<_Tp>, in_place_t>);
719 static_assert(is_object_v<_Tp> && !is_array_v<_Tp>);
722 using _Base = _Optional_base<_Tp>;
725 template<typename _Up>
726 using __not_self = __not_<is_same<optional, __remove_cvref_t<_Up>>>;
727 template<typename _Up>
728 using __not_tag = __not_<is_same<in_place_t, __remove_cvref_t<_Up>>>;
729 template<typename... _Cond>
730 using _Requires = enable_if_t<__and_v<_Cond...>, bool>;
733 using value_type = _Tp;
735 constexpr optional() noexcept { }
737 constexpr optional(nullopt_t) noexcept { }
739 // Converting constructors for engaged optionals.
740 template<typename _Up = _Tp,
741 _Requires<__not_self<_Up>, __not_tag<_Up>,
742 is_constructible<_Tp, _Up>,
743 is_convertible<_Up, _Tp>> = true>
746 noexcept(is_nothrow_constructible_v<_Tp, _Up>)
747 : _Base(std::in_place, std::forward<_Up>(__t)) { }
749 template<typename _Up = _Tp,
750 _Requires<__not_self<_Up>, __not_tag<_Up>,
751 is_constructible<_Tp, _Up>,
752 __not_<is_convertible<_Up, _Tp>>> = false>
755 noexcept(is_nothrow_constructible_v<_Tp, _Up>)
756 : _Base(std::in_place, std::forward<_Up>(__t)) { }
758 template<typename _Up,
759 _Requires<__not_<is_same<_Tp, _Up>>,
760 is_constructible<_Tp, const _Up&>,
761 is_convertible<const _Up&, _Tp>,
762 __not_<__converts_from_optional<_Tp, _Up>>> = true>
764 optional(const optional<_Up>& __t)
765 noexcept(is_nothrow_constructible_v<_Tp, const _Up&>)
771 template<typename _Up,
772 _Requires<__not_<is_same<_Tp, _Up>>,
773 is_constructible<_Tp, const _Up&>,
774 __not_<is_convertible<const _Up&, _Tp>>,
775 __not_<__converts_from_optional<_Tp, _Up>>> = false>
777 optional(const optional<_Up>& __t)
778 noexcept(is_nothrow_constructible_v<_Tp, const _Up&>)
784 template<typename _Up,
785 _Requires<__not_<is_same<_Tp, _Up>>,
786 is_constructible<_Tp, _Up>,
787 is_convertible<_Up, _Tp>,
788 __not_<__converts_from_optional<_Tp, _Up>>> = true>
790 optional(optional<_Up>&& __t)
791 noexcept(is_nothrow_constructible_v<_Tp, _Up>)
794 emplace(std::move(*__t));
797 template<typename _Up,
798 _Requires<__not_<is_same<_Tp, _Up>>,
799 is_constructible<_Tp, _Up>,
800 __not_<is_convertible<_Up, _Tp>>,
801 __not_<__converts_from_optional<_Tp, _Up>>> = false>
803 optional(optional<_Up>&& __t)
804 noexcept(is_nothrow_constructible_v<_Tp, _Up>)
807 emplace(std::move(*__t));
810 template<typename... _Args,
811 _Requires<is_constructible<_Tp, _Args...>> = false>
813 optional(in_place_t, _Args&&... __args)
814 noexcept(is_nothrow_constructible_v<_Tp, _Args...>)
815 : _Base(std::in_place, std::forward<_Args>(__args)...) { }
817 template<typename _Up, typename... _Args,
818 _Requires<is_constructible<_Tp,
819 initializer_list<_Up>&,
822 optional(in_place_t, initializer_list<_Up> __il, _Args&&... __args)
823 noexcept(is_nothrow_constructible_v<_Tp, initializer_list<_Up>&,
825 : _Base(std::in_place, __il, std::forward<_Args>(__args)...) { }
828 // Assignment operators.
829 _GLIBCXX20_CONSTEXPR optional&
830 operator=(nullopt_t) noexcept
836 template<typename _Up = _Tp>
838 enable_if_t<__and_v<__not_self<_Up>,
839 __not_<__and_<is_scalar<_Tp>,
840 is_same<_Tp, decay_t<_Up>>>>,
841 is_constructible<_Tp, _Up>,
842 is_assignable<_Tp&, _Up>>,
845 noexcept(__and_v<is_nothrow_constructible<_Tp, _Up>,
846 is_nothrow_assignable<_Tp&, _Up>>)
848 if (this->_M_is_engaged())
849 this->_M_get() = std::forward<_Up>(__u);
851 this->_M_construct(std::forward<_Up>(__u));
856 template<typename _Up>
858 enable_if_t<__and_v<__not_<is_same<_Tp, _Up>>,
859 is_constructible<_Tp, const _Up&>,
860 is_assignable<_Tp&, const _Up&>,
861 __not_<__converts_from_optional<_Tp, _Up>>,
862 __not_<__assigns_from_optional<_Tp, _Up>>>,
864 operator=(const optional<_Up>& __u)
865 noexcept(__and_v<is_nothrow_constructible<_Tp, const _Up&>,
866 is_nothrow_assignable<_Tp&, const _Up&>>)
870 if (this->_M_is_engaged())
871 this->_M_get() = *__u;
873 this->_M_construct(*__u);
882 template<typename _Up>
884 enable_if_t<__and_v<__not_<is_same<_Tp, _Up>>,
885 is_constructible<_Tp, _Up>,
886 is_assignable<_Tp&, _Up>,
887 __not_<__converts_from_optional<_Tp, _Up>>,
888 __not_<__assigns_from_optional<_Tp, _Up>>>,
890 operator=(optional<_Up>&& __u)
891 noexcept(__and_v<is_nothrow_constructible<_Tp, _Up>,
892 is_nothrow_assignable<_Tp&, _Up>>)
896 if (this->_M_is_engaged())
897 this->_M_get() = std::move(*__u);
899 this->_M_construct(std::move(*__u));
909 template<typename... _Args>
911 enable_if_t<is_constructible_v<_Tp, _Args...>, _Tp&>
912 emplace(_Args&&... __args)
913 noexcept(is_nothrow_constructible_v<_Tp, _Args...>)
916 this->_M_construct(std::forward<_Args>(__args)...);
917 return this->_M_get();
920 template<typename _Up, typename... _Args>
922 enable_if_t<is_constructible_v<_Tp, initializer_list<_Up>&, _Args...>,
924 emplace(initializer_list<_Up> __il, _Args&&... __args)
925 noexcept(is_nothrow_constructible_v<_Tp, initializer_list<_Up>&,
929 this->_M_construct(__il, std::forward<_Args>(__args)...);
930 return this->_M_get();
933 // Destructor is implicit, implemented in _Optional_base.
936 _GLIBCXX20_CONSTEXPR void
937 swap(optional& __other)
938 noexcept(is_nothrow_move_constructible_v<_Tp>
939 && is_nothrow_swappable_v<_Tp>)
943 if (this->_M_is_engaged() && __other._M_is_engaged())
944 swap(this->_M_get(), __other._M_get());
945 else if (this->_M_is_engaged())
947 __other._M_construct(std::move(this->_M_get()));
950 else if (__other._M_is_engaged())
952 this->_M_construct(std::move(__other._M_get()));
953 __other._M_destruct();
959 operator->() const noexcept
960 { return std::__addressof(this->_M_get()); }
963 operator->() noexcept
964 { return std::__addressof(this->_M_get()); }
967 operator*() const& noexcept
968 { return this->_M_get(); }
971 operator*()& noexcept
972 { return this->_M_get(); }
975 operator*()&& noexcept
976 { return std::move(this->_M_get()); }
978 constexpr const _Tp&&
979 operator*() const&& noexcept
980 { return std::move(this->_M_get()); }
982 constexpr explicit operator bool() const noexcept
983 { return this->_M_is_engaged(); }
985 constexpr bool has_value() const noexcept
986 { return this->_M_is_engaged(); }
991 if (this->_M_is_engaged())
992 return this->_M_get();
993 __throw_bad_optional_access();
999 if (this->_M_is_engaged())
1000 return this->_M_get();
1001 __throw_bad_optional_access();
1007 if (this->_M_is_engaged())
1008 return std::move(this->_M_get());
1009 __throw_bad_optional_access();
1012 constexpr const _Tp&&
1015 if (this->_M_is_engaged())
1016 return std::move(this->_M_get());
1017 __throw_bad_optional_access();
1020 template<typename _Up>
1022 value_or(_Up&& __u) const&
1024 static_assert(is_copy_constructible_v<_Tp>);
1025 static_assert(is_convertible_v<_Up&&, _Tp>);
1027 if (this->_M_is_engaged())
1028 return this->_M_get();
1030 return static_cast<_Tp>(std::forward<_Up>(__u));
1033 template<typename _Up>
1035 value_or(_Up&& __u) &&
1037 static_assert(is_move_constructible_v<_Tp>);
1038 static_assert(is_convertible_v<_Up&&, _Tp>);
1040 if (this->_M_is_engaged())
1041 return std::move(this->_M_get());
1043 return static_cast<_Tp>(std::forward<_Up>(__u));
1046 #if __cpp_lib_optional >= 202110L
1047 // [optional.monadic]
1049 template<typename _Fn>
1051 and_then(_Fn&& __f) &
1053 using _Up = remove_cvref_t<invoke_result_t<_Fn, _Tp&>>;
1054 static_assert(__is_optional_v<remove_cvref_t<_Up>>,
1055 "the function passed to std::optional<T>::and_then "
1056 "must return a std::optional");
1058 return std::__invoke(std::forward<_Fn>(__f), **this);
1063 template<typename _Fn>
1065 and_then(_Fn&& __f) const &
1067 using _Up = remove_cvref_t<invoke_result_t<_Fn, const _Tp&>>;
1068 static_assert(__is_optional_v<_Up>,
1069 "the function passed to std::optional<T>::and_then "
1070 "must return a std::optional");
1072 return std::__invoke(std::forward<_Fn>(__f), **this);
1077 template<typename _Fn>
1079 and_then(_Fn&& __f) &&
1081 using _Up = remove_cvref_t<invoke_result_t<_Fn, _Tp>>;
1082 static_assert(__is_optional_v<remove_cvref_t<_Up>>,
1083 "the function passed to std::optional<T>::and_then "
1084 "must return a std::optional");
1086 return std::__invoke(std::forward<_Fn>(__f), std::move(**this));
1091 template<typename _Fn>
1093 and_then(_Fn&& __f) const &&
1095 using _Up = remove_cvref_t<invoke_result_t<_Fn, const _Tp>>;
1096 static_assert(__is_optional_v<remove_cvref_t<_Up>>,
1097 "the function passed to std::optional<T>::and_then "
1098 "must return a std::optional");
1100 return std::__invoke(std::forward<_Fn>(__f), std::move(**this));
1105 template<typename _Fn>
1107 transform(_Fn&& __f) &
1109 using _Up = remove_cv_t<invoke_result_t<_Fn, _Tp&>>;
1111 return optional<_Up>(_Optional_func<_Fn>{__f}, **this);
1113 return optional<_Up>();
1116 template<typename _Fn>
1118 transform(_Fn&& __f) const &
1120 using _Up = remove_cv_t<invoke_result_t<_Fn, const _Tp&>>;
1122 return optional<_Up>(_Optional_func<_Fn>{__f}, **this);
1124 return optional<_Up>();
1127 template<typename _Fn>
1129 transform(_Fn&& __f) &&
1131 using _Up = remove_cv_t<invoke_result_t<_Fn, _Tp>>;
1133 return optional<_Up>(_Optional_func<_Fn>{__f}, std::move(**this));
1135 return optional<_Up>();
1138 template<typename _Fn>
1140 transform(_Fn&& __f) const &&
1142 using _Up = remove_cv_t<invoke_result_t<_Fn, const _Tp>>;
1144 return optional<_Up>(_Optional_func<_Fn>{__f}, std::move(**this));
1146 return optional<_Up>();
1149 template<typename _Fn> requires invocable<_Fn> && copy_constructible<_Tp>
1151 or_else(_Fn&& __f) const&
1153 using _Up = invoke_result_t<_Fn>;
1154 static_assert(is_same_v<remove_cvref_t<_Up>, optional>,
1155 "the function passed to std::optional<T>::or_else "
1156 "must return a std::optional<T>");
1161 return std::forward<_Fn>(__f)();
1164 template<typename _Fn> requires invocable<_Fn> && move_constructible<_Tp>
1166 or_else(_Fn&& __f) &&
1168 using _Up = invoke_result_t<_Fn>;
1169 static_assert(is_same_v<remove_cvref_t<_Up>, optional>,
1170 "the function passed to std::optional<T>::or_else "
1171 "must return a std::optional<T>");
1174 return std::move(*this);
1176 return std::forward<_Fn>(__f)();
1180 _GLIBCXX20_CONSTEXPR void reset() noexcept { this->_M_reset(); }
1183 #if __cplusplus >= 202002L
1184 template<typename _Up> friend class optional;
1186 template<typename _Fn, typename _Value>
1188 optional(_Optional_func<_Fn> __f, _Value&& __v)
1190 this->_M_payload._M_apply(__f, std::forward<_Value>(__v));
1195 template<typename _Tp>
1196 using __optional_relop_t =
1197 enable_if_t<is_convertible<_Tp, bool>::value, bool>;
1199 template<typename _Tp, typename _Up>
1200 using __optional_eq_t = __optional_relop_t<
1201 decltype(std::declval<const _Tp&>() == std::declval<const _Up&>())
1204 template<typename _Tp, typename _Up>
1205 using __optional_ne_t = __optional_relop_t<
1206 decltype(std::declval<const _Tp&>() != std::declval<const _Up&>())
1209 template<typename _Tp, typename _Up>
1210 using __optional_lt_t = __optional_relop_t<
1211 decltype(std::declval<const _Tp&>() < std::declval<const _Up&>())
1214 template<typename _Tp, typename _Up>
1215 using __optional_gt_t = __optional_relop_t<
1216 decltype(std::declval<const _Tp&>() > std::declval<const _Up&>())
1219 template<typename _Tp, typename _Up>
1220 using __optional_le_t = __optional_relop_t<
1221 decltype(std::declval<const _Tp&>() <= std::declval<const _Up&>())
1224 template<typename _Tp, typename _Up>
1225 using __optional_ge_t = __optional_relop_t<
1226 decltype(std::declval<const _Tp&>() >= std::declval<const _Up&>())
1229 // Comparisons between optional values.
1230 template<typename _Tp, typename _Up>
1232 operator==(const optional<_Tp>& __lhs, const optional<_Up>& __rhs)
1233 -> __optional_eq_t<_Tp, _Up>
1235 return static_cast<bool>(__lhs) == static_cast<bool>(__rhs)
1236 && (!__lhs || *__lhs == *__rhs);
1239 template<typename _Tp, typename _Up>
1241 operator!=(const optional<_Tp>& __lhs, const optional<_Up>& __rhs)
1242 -> __optional_ne_t<_Tp, _Up>
1244 return static_cast<bool>(__lhs) != static_cast<bool>(__rhs)
1245 || (static_cast<bool>(__lhs) && *__lhs != *__rhs);
1248 template<typename _Tp, typename _Up>
1250 operator<(const optional<_Tp>& __lhs, const optional<_Up>& __rhs)
1251 -> __optional_lt_t<_Tp, _Up>
1253 return static_cast<bool>(__rhs) && (!__lhs || *__lhs < *__rhs);
1256 template<typename _Tp, typename _Up>
1258 operator>(const optional<_Tp>& __lhs, const optional<_Up>& __rhs)
1259 -> __optional_gt_t<_Tp, _Up>
1261 return static_cast<bool>(__lhs) && (!__rhs || *__lhs > *__rhs);
1264 template<typename _Tp, typename _Up>
1266 operator<=(const optional<_Tp>& __lhs, const optional<_Up>& __rhs)
1267 -> __optional_le_t<_Tp, _Up>
1269 return !__lhs || (static_cast<bool>(__rhs) && *__lhs <= *__rhs);
1272 template<typename _Tp, typename _Up>
1274 operator>=(const optional<_Tp>& __lhs, const optional<_Up>& __rhs)
1275 -> __optional_ge_t<_Tp, _Up>
1277 return !__rhs || (static_cast<bool>(__lhs) && *__lhs >= *__rhs);
1280 #ifdef __cpp_lib_three_way_comparison
1281 template<typename _Tp, three_way_comparable_with<_Tp> _Up>
1282 constexpr compare_three_way_result_t<_Tp, _Up>
1283 operator<=>(const optional<_Tp>& __x, const optional<_Up>& __y)
1285 return __x && __y ? *__x <=> *__y : bool(__x) <=> bool(__y);
1289 // Comparisons with nullopt.
1290 template<typename _Tp>
1292 operator==(const optional<_Tp>& __lhs, nullopt_t) noexcept
1295 #ifdef __cpp_lib_three_way_comparison
1296 template<typename _Tp>
1297 constexpr strong_ordering
1298 operator<=>(const optional<_Tp>& __x, nullopt_t) noexcept
1299 { return bool(__x) <=> false; }
1301 template<typename _Tp>
1303 operator==(nullopt_t, const optional<_Tp>& __rhs) noexcept
1306 template<typename _Tp>
1308 operator!=(const optional<_Tp>& __lhs, nullopt_t) noexcept
1309 { return static_cast<bool>(__lhs); }
1311 template<typename _Tp>
1313 operator!=(nullopt_t, const optional<_Tp>& __rhs) noexcept
1314 { return static_cast<bool>(__rhs); }
1316 template<typename _Tp>
1318 operator<(const optional<_Tp>& /* __lhs */, nullopt_t) noexcept
1321 template<typename _Tp>
1323 operator<(nullopt_t, const optional<_Tp>& __rhs) noexcept
1324 { return static_cast<bool>(__rhs); }
1326 template<typename _Tp>
1328 operator>(const optional<_Tp>& __lhs, nullopt_t) noexcept
1329 { return static_cast<bool>(__lhs); }
1331 template<typename _Tp>
1333 operator>(nullopt_t, const optional<_Tp>& /* __rhs */) noexcept
1336 template<typename _Tp>
1338 operator<=(const optional<_Tp>& __lhs, nullopt_t) noexcept
1341 template<typename _Tp>
1343 operator<=(nullopt_t, const optional<_Tp>& /* __rhs */) noexcept
1346 template<typename _Tp>
1348 operator>=(const optional<_Tp>& /* __lhs */, nullopt_t) noexcept
1351 template<typename _Tp>
1353 operator>=(nullopt_t, const optional<_Tp>& __rhs) noexcept
1355 #endif // three-way-comparison
1357 // Comparisons with value type.
1358 template<typename _Tp, typename _Up>
1360 operator==(const optional<_Tp>& __lhs, const _Up& __rhs)
1361 -> __optional_eq_t<_Tp, _Up>
1362 { return __lhs && *__lhs == __rhs; }
1364 template<typename _Tp, typename _Up>
1366 operator==(const _Up& __lhs, const optional<_Tp>& __rhs)
1367 -> __optional_eq_t<_Up, _Tp>
1368 { return __rhs && __lhs == *__rhs; }
1370 template<typename _Tp, typename _Up>
1372 operator!=(const optional<_Tp>& __lhs, const _Up& __rhs)
1373 -> __optional_ne_t<_Tp, _Up>
1374 { return !__lhs || *__lhs != __rhs; }
1376 template<typename _Tp, typename _Up>
1378 operator!=(const _Up& __lhs, const optional<_Tp>& __rhs)
1379 -> __optional_ne_t<_Up, _Tp>
1380 { return !__rhs || __lhs != *__rhs; }
1382 template<typename _Tp, typename _Up>
1384 operator<(const optional<_Tp>& __lhs, const _Up& __rhs)
1385 -> __optional_lt_t<_Tp, _Up>
1386 { return !__lhs || *__lhs < __rhs; }
1388 template<typename _Tp, typename _Up>
1390 operator<(const _Up& __lhs, const optional<_Tp>& __rhs)
1391 -> __optional_lt_t<_Up, _Tp>
1392 { return __rhs && __lhs < *__rhs; }
1394 template<typename _Tp, typename _Up>
1396 operator>(const optional<_Tp>& __lhs, const _Up& __rhs)
1397 -> __optional_gt_t<_Tp, _Up>
1398 { return __lhs && *__lhs > __rhs; }
1400 template<typename _Tp, typename _Up>
1402 operator>(const _Up& __lhs, const optional<_Tp>& __rhs)
1403 -> __optional_gt_t<_Up, _Tp>
1404 { return !__rhs || __lhs > *__rhs; }
1406 template<typename _Tp, typename _Up>
1408 operator<=(const optional<_Tp>& __lhs, const _Up& __rhs)
1409 -> __optional_le_t<_Tp, _Up>
1410 { return !__lhs || *__lhs <= __rhs; }
1412 template<typename _Tp, typename _Up>
1414 operator<=(const _Up& __lhs, const optional<_Tp>& __rhs)
1415 -> __optional_le_t<_Up, _Tp>
1416 { return __rhs && __lhs <= *__rhs; }
1418 template<typename _Tp, typename _Up>
1420 operator>=(const optional<_Tp>& __lhs, const _Up& __rhs)
1421 -> __optional_ge_t<_Tp, _Up>
1422 { return __lhs && *__lhs >= __rhs; }
1424 template<typename _Tp, typename _Up>
1426 operator>=(const _Up& __lhs, const optional<_Tp>& __rhs)
1427 -> __optional_ge_t<_Up, _Tp>
1428 { return !__rhs || __lhs >= *__rhs; }
1430 #ifdef __cpp_lib_three_way_comparison
1431 template<typename _Tp, typename _Up>
1432 requires (!__is_optional_v<_Up>)
1433 && three_way_comparable_with<_Tp, _Up>
1434 constexpr compare_three_way_result_t<_Tp, _Up>
1435 operator<=>(const optional<_Tp>& __x, const _Up& __v)
1436 { return bool(__x) ? *__x <=> __v : strong_ordering::less; }
1439 // Swap and creation functions.
1441 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1442 // 2748. swappable traits for optionals
1443 template<typename _Tp>
1444 _GLIBCXX20_CONSTEXPR
1445 inline enable_if_t<is_move_constructible_v<_Tp> && is_swappable_v<_Tp>>
1446 swap(optional<_Tp>& __lhs, optional<_Tp>& __rhs)
1447 noexcept(noexcept(__lhs.swap(__rhs)))
1448 { __lhs.swap(__rhs); }
1450 template<typename _Tp>
1451 enable_if_t<!(is_move_constructible_v<_Tp> && is_swappable_v<_Tp>)>
1452 swap(optional<_Tp>&, optional<_Tp>&) = delete;
1454 template<typename _Tp>
1456 enable_if_t<is_constructible_v<decay_t<_Tp>, _Tp>,
1457 optional<decay_t<_Tp>>>
1458 make_optional(_Tp&& __t)
1459 noexcept(is_nothrow_constructible_v<optional<decay_t<_Tp>>, _Tp>)
1460 { return optional<decay_t<_Tp>>{ std::forward<_Tp>(__t) }; }
1462 template<typename _Tp, typename... _Args>
1464 enable_if_t<is_constructible_v<_Tp, _Args...>,
1466 make_optional(_Args&&... __args)
1467 noexcept(is_nothrow_constructible_v<_Tp, _Args...>)
1468 { return optional<_Tp>{ in_place, std::forward<_Args>(__args)... }; }
1470 template<typename _Tp, typename _Up, typename... _Args>
1472 enable_if_t<is_constructible_v<_Tp, initializer_list<_Up>&, _Args...>,
1474 make_optional(initializer_list<_Up> __il, _Args&&... __args)
1475 noexcept(is_nothrow_constructible_v<_Tp, initializer_list<_Up>&, _Args...>)
1476 { return optional<_Tp>{ in_place, __il, std::forward<_Args>(__args)... }; }
1480 template<typename _Tp, typename _Up = remove_const_t<_Tp>,
1481 bool = __poison_hash<_Up>::__enable_hash_call>
1482 struct __optional_hash_call_base
1485 operator()(const optional<_Tp>& __t) const
1486 noexcept(noexcept(hash<_Up>{}(*__t)))
1488 // We pick an arbitrary hash for disengaged optionals which hopefully
1489 // usual values of _Tp won't typically hash to.
1490 constexpr size_t __magic_disengaged_hash = static_cast<size_t>(-3333);
1491 return __t ? hash<_Up>{}(*__t) : __magic_disengaged_hash;
1495 template<typename _Tp, typename _Up>
1496 struct __optional_hash_call_base<_Tp, _Up, false> {};
1498 template<typename _Tp>
1499 struct hash<optional<_Tp>>
1500 : private __poison_hash<remove_const_t<_Tp>>,
1501 public __optional_hash_call_base<_Tp>
1503 using result_type [[__deprecated__]] = size_t;
1504 using argument_type [[__deprecated__]] = optional<_Tp>;
1507 template<typename _Tp>
1508 struct __is_fast_hash<hash<optional<_Tp>>> : __is_fast_hash<hash<_Tp>>
1513 #if __cpp_deduction_guides >= 201606
1514 template <typename _Tp> optional(_Tp) -> optional<_Tp>;
1517 _GLIBCXX_END_NAMESPACE_VERSION
1520 #endif // __cpp_lib_optional
1522 #endif // _GLIBCXX_OPTIONAL