mirror of
https://github.com/TartanLlama/optional.git
synced 2025-07-29 17:37:13 +02:00
Initial commit
This commit is contained in:
121
COPYING
Normal file
121
COPYING
Normal file
@ -0,0 +1,121 @@
|
|||||||
|
Creative Commons Legal Code
|
||||||
|
|
||||||
|
CC0 1.0 Universal
|
||||||
|
|
||||||
|
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
|
||||||
|
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
|
||||||
|
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
|
||||||
|
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
|
||||||
|
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
|
||||||
|
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
|
||||||
|
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
|
||||||
|
HEREUNDER.
|
||||||
|
|
||||||
|
Statement of Purpose
|
||||||
|
|
||||||
|
The laws of most jurisdictions throughout the world automatically confer
|
||||||
|
exclusive Copyright and Related Rights (defined below) upon the creator
|
||||||
|
and subsequent owner(s) (each and all, an "owner") of an original work of
|
||||||
|
authorship and/or a database (each, a "Work").
|
||||||
|
|
||||||
|
Certain owners wish to permanently relinquish those rights to a Work for
|
||||||
|
the purpose of contributing to a commons of creative, cultural and
|
||||||
|
scientific works ("Commons") that the public can reliably and without fear
|
||||||
|
of later claims of infringement build upon, modify, incorporate in other
|
||||||
|
works, reuse and redistribute as freely as possible in any form whatsoever
|
||||||
|
and for any purposes, including without limitation commercial purposes.
|
||||||
|
These owners may contribute to the Commons to promote the ideal of a free
|
||||||
|
culture and the further production of creative, cultural and scientific
|
||||||
|
works, or to gain reputation or greater distribution for their Work in
|
||||||
|
part through the use and efforts of others.
|
||||||
|
|
||||||
|
For these and/or other purposes and motivations, and without any
|
||||||
|
expectation of additional consideration or compensation, the person
|
||||||
|
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
|
||||||
|
is an owner of Copyright and Related Rights in the Work, voluntarily
|
||||||
|
elects to apply CC0 to the Work and publicly distribute the Work under its
|
||||||
|
terms, with knowledge of his or her Copyright and Related Rights in the
|
||||||
|
Work and the meaning and intended legal effect of CC0 on those rights.
|
||||||
|
|
||||||
|
1. Copyright and Related Rights. A Work made available under CC0 may be
|
||||||
|
protected by copyright and related or neighboring rights ("Copyright and
|
||||||
|
Related Rights"). Copyright and Related Rights include, but are not
|
||||||
|
limited to, the following:
|
||||||
|
|
||||||
|
i. the right to reproduce, adapt, distribute, perform, display,
|
||||||
|
communicate, and translate a Work;
|
||||||
|
ii. moral rights retained by the original author(s) and/or performer(s);
|
||||||
|
iii. publicity and privacy rights pertaining to a person's image or
|
||||||
|
likeness depicted in a Work;
|
||||||
|
iv. rights protecting against unfair competition in regards to a Work,
|
||||||
|
subject to the limitations in paragraph 4(a), below;
|
||||||
|
v. rights protecting the extraction, dissemination, use and reuse of data
|
||||||
|
in a Work;
|
||||||
|
vi. database rights (such as those arising under Directive 96/9/EC of the
|
||||||
|
European Parliament and of the Council of 11 March 1996 on the legal
|
||||||
|
protection of databases, and under any national implementation
|
||||||
|
thereof, including any amended or successor version of such
|
||||||
|
directive); and
|
||||||
|
vii. other similar, equivalent or corresponding rights throughout the
|
||||||
|
world based on applicable law or treaty, and any national
|
||||||
|
implementations thereof.
|
||||||
|
|
||||||
|
2. Waiver. To the greatest extent permitted by, but not in contravention
|
||||||
|
of, applicable law, Affirmer hereby overtly, fully, permanently,
|
||||||
|
irrevocably and unconditionally waives, abandons, and surrenders all of
|
||||||
|
Affirmer's Copyright and Related Rights and associated claims and causes
|
||||||
|
of action, whether now known or unknown (including existing as well as
|
||||||
|
future claims and causes of action), in the Work (i) in all territories
|
||||||
|
worldwide, (ii) for the maximum duration provided by applicable law or
|
||||||
|
treaty (including future time extensions), (iii) in any current or future
|
||||||
|
medium and for any number of copies, and (iv) for any purpose whatsoever,
|
||||||
|
including without limitation commercial, advertising or promotional
|
||||||
|
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
|
||||||
|
member of the public at large and to the detriment of Affirmer's heirs and
|
||||||
|
successors, fully intending that such Waiver shall not be subject to
|
||||||
|
revocation, rescission, cancellation, termination, or any other legal or
|
||||||
|
equitable action to disrupt the quiet enjoyment of the Work by the public
|
||||||
|
as contemplated by Affirmer's express Statement of Purpose.
|
||||||
|
|
||||||
|
3. Public License Fallback. Should any part of the Waiver for any reason
|
||||||
|
be judged legally invalid or ineffective under applicable law, then the
|
||||||
|
Waiver shall be preserved to the maximum extent permitted taking into
|
||||||
|
account Affirmer's express Statement of Purpose. In addition, to the
|
||||||
|
extent the Waiver is so judged Affirmer hereby grants to each affected
|
||||||
|
person a royalty-free, non transferable, non sublicensable, non exclusive,
|
||||||
|
irrevocable and unconditional license to exercise Affirmer's Copyright and
|
||||||
|
Related Rights in the Work (i) in all territories worldwide, (ii) for the
|
||||||
|
maximum duration provided by applicable law or treaty (including future
|
||||||
|
time extensions), (iii) in any current or future medium and for any number
|
||||||
|
of copies, and (iv) for any purpose whatsoever, including without
|
||||||
|
limitation commercial, advertising or promotional purposes (the
|
||||||
|
"License"). The License shall be deemed effective as of the date CC0 was
|
||||||
|
applied by Affirmer to the Work. Should any part of the License for any
|
||||||
|
reason be judged legally invalid or ineffective under applicable law, such
|
||||||
|
partial invalidity or ineffectiveness shall not invalidate the remainder
|
||||||
|
of the License, and in such case Affirmer hereby affirms that he or she
|
||||||
|
will not (i) exercise any of his or her remaining Copyright and Related
|
||||||
|
Rights in the Work or (ii) assert any associated claims and causes of
|
||||||
|
action with respect to the Work, in either case contrary to Affirmer's
|
||||||
|
express Statement of Purpose.
|
||||||
|
|
||||||
|
4. Limitations and Disclaimers.
|
||||||
|
|
||||||
|
a. No trademark or patent rights held by Affirmer are waived, abandoned,
|
||||||
|
surrendered, licensed or otherwise affected by this document.
|
||||||
|
b. Affirmer offers the Work as-is and makes no representations or
|
||||||
|
warranties of any kind concerning the Work, express, implied,
|
||||||
|
statutory or otherwise, including without limitation warranties of
|
||||||
|
title, merchantability, fitness for a particular purpose, non
|
||||||
|
infringement, or the absence of latent or other defects, accuracy, or
|
||||||
|
the present or absence of errors, whether or not discoverable, all to
|
||||||
|
the greatest extent permissible under applicable law.
|
||||||
|
c. Affirmer disclaims responsibility for clearing rights of other persons
|
||||||
|
that may apply to the Work or any use thereof, including without
|
||||||
|
limitation any person's Copyright and Related Rights in the Work.
|
||||||
|
Further, Affirmer disclaims responsibility for obtaining any necessary
|
||||||
|
consents, permissions or other rights required for any use of the
|
||||||
|
Work.
|
||||||
|
d. Affirmer understands and acknowledges that Creative Commons is not a
|
||||||
|
party to this document and has no duty or obligation with respect to
|
||||||
|
this CC0 or use of the Work.
|
304
optional.hpp
Normal file
304
optional.hpp
Normal file
@ -0,0 +1,304 @@
|
|||||||
|
///
|
||||||
|
// optional - An implementation of std::optional with extensions
|
||||||
|
// Written in 2017 by Simon Brand (@TartanLlama)
|
||||||
|
//
|
||||||
|
// To the extent possible under law, the author(s) have dedicated all
|
||||||
|
// copyright and related and neighboring rights to this software to the
|
||||||
|
// public domain worldwide. This software is distributed without any warranty.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the CC0 Public Domain Dedication
|
||||||
|
// along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
|
||||||
|
///
|
||||||
|
|
||||||
|
#include <type_traits>
|
||||||
|
#include "tl/type_traits.hpp"
|
||||||
|
|
||||||
|
namespace tl {
|
||||||
|
// [optional.optional], class template optional
|
||||||
|
template <class T>
|
||||||
|
class optional;
|
||||||
|
|
||||||
|
// [optional.nullopt], no-value state indicator
|
||||||
|
struct nullopt_t{};
|
||||||
|
inline constexpr nullopt_t nullopt;
|
||||||
|
|
||||||
|
// [optional.bad.access], class bad_optional_access
|
||||||
|
class bad_optional_access : public std::exception {
|
||||||
|
bad_optional_access() = default;
|
||||||
|
const char* what() const {
|
||||||
|
return "Optional has no value";
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// [optional.relops], relational operators
|
||||||
|
template <class T, class U>
|
||||||
|
inline constexpr bool operator==(const optional<T>& lhs, const optional<U>& rhs) {
|
||||||
|
if (lhs.has_value() != rhs.has_value())
|
||||||
|
return false;
|
||||||
|
if (lhs.has_value())
|
||||||
|
return true;
|
||||||
|
|
||||||
|
return lhs.value() == rhs.value();
|
||||||
|
}
|
||||||
|
template <class T, class U>
|
||||||
|
inline constexpr bool operator!=(const optional<T>& lhs, const optional<U>& rhs) {
|
||||||
|
if (lhs.has_value() != rhs.has_value())
|
||||||
|
return true;
|
||||||
|
if (lhs.has_value())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return lhs.value() != rhs.value();
|
||||||
|
}
|
||||||
|
template <class T, class U>
|
||||||
|
inline constexpr bool operator<(const optional<T>& lhs, const optional<U>& rhs) {
|
||||||
|
if (!rhs.has_value())
|
||||||
|
return false;
|
||||||
|
if (!lhs.has_value())
|
||||||
|
return true;
|
||||||
|
|
||||||
|
return lhs.value() < rhs.value();
|
||||||
|
}
|
||||||
|
template <class T, class U>
|
||||||
|
inline constexpr bool operator>(const optional<T>& lhs, const optional<U>& rhs) {
|
||||||
|
if (!lhs.has_value())
|
||||||
|
return false;
|
||||||
|
if (!rhs.has_value())
|
||||||
|
return true;
|
||||||
|
|
||||||
|
return lhs.value() > rhs.value();
|
||||||
|
}
|
||||||
|
template <class T, class U>
|
||||||
|
inline constexpr bool operator<=(const optional<T>& lhs, const optional<U>& rhs) {
|
||||||
|
if (!lhs.has_value())
|
||||||
|
return true;
|
||||||
|
if (!rhs.has_value())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return lhs.value() <= rhs.value();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
template <class T, class U>
|
||||||
|
inline constexpr bool operator>=(const optional<T>& lhs, const optional<U>& rhs) {
|
||||||
|
if (!rhs.has_value())
|
||||||
|
return true;
|
||||||
|
if (!lhs.has_value())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
return lhs.value() >= rhs.value();
|
||||||
|
}
|
||||||
|
|
||||||
|
// [optional.nullops], comparison with nullopt
|
||||||
|
template <class T> inline constexpr bool operator==(const optional<T>& lhs, nullopt_t) noexcept {
|
||||||
|
return !lhs.has_value();
|
||||||
|
}
|
||||||
|
template <class T> inline constexpr bool operator==(nullopt_t, const optional<T>& rhs) noexcept {
|
||||||
|
return !rhs.has_value();
|
||||||
|
}
|
||||||
|
template <class T> inline constexpr bool operator!=(const optional<T>& lhs, nullopt_t) noexcept {
|
||||||
|
return lhs.has_value();
|
||||||
|
}
|
||||||
|
template <class T> inline constexpr bool operator!=(nullopt_t, const optional<T>& rhs) noexcept {
|
||||||
|
return rhs.has_value();
|
||||||
|
}
|
||||||
|
template <class T> inline constexpr bool operator<(const optional<T>&, nullopt_t) noexcept {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
template <class T> inline constexpr bool operator<(nullopt_t, const optional<T>& rhs) noexcept {
|
||||||
|
return rhs.has_value();
|
||||||
|
}
|
||||||
|
template <class T> inline constexpr bool operator<=(const optional<T>& lhs, nullopt_t) noexcept {
|
||||||
|
return !lhs.has_value();
|
||||||
|
}
|
||||||
|
template <class T> inline constexpr bool operator<=(nullopt_t, const optional<T>&) noexcept {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
template <class T> inline constexpr bool operator>(const optional<T>& lhs, nullopt_t) noexcept {
|
||||||
|
return lhs.has_value();
|
||||||
|
}
|
||||||
|
template <class T> inline constexpr bool operator>(nullopt_t, const optional<T>&) noexcept {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
template <class T> inline constexpr bool operator>=(const optional<T>&, nullopt_t) noexcept {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
template <class T> inline constexpr bool operator>=(nullopt_t, const optional<T>& rhs) noexcept {
|
||||||
|
return !rhs.has_value();
|
||||||
|
}
|
||||||
|
|
||||||
|
// [optional.comp_with_t], comparison with T
|
||||||
|
template <class T, class U> inline constexpr bool operator==(const optional<T>& lhs, const U& rhs) {
|
||||||
|
return lhs.has_value() ? *lhs == rhs : false;
|
||||||
|
}
|
||||||
|
template <class T, class U> inline constexpr bool operator==(const U& lhs, const optional<T>& rhs) {
|
||||||
|
return rhs.has_value() ? lhs == rhs.value() : false;
|
||||||
|
}
|
||||||
|
template <class T, class U> inline constexpr bool operator!=(const optional<T>& lhs, const U& rhs) {
|
||||||
|
return lhs.has_value() ? lhs.value() != lhs : true;
|
||||||
|
}
|
||||||
|
template <class T, class U> inline constexpr bool operator!=(const U& lhs, const optional<T>& rhs) {
|
||||||
|
return rhs.has_value() ? lhs != rhs.value() : true;
|
||||||
|
}
|
||||||
|
template <class T, class U> inline constexpr bool operator<(const optional<T>& lhs, const U& rhs) {
|
||||||
|
return lhs.has_value() ? lhs.value() < lhs : true;
|
||||||
|
}
|
||||||
|
template <class T, class U> inline constexpr bool operator<(const U& lhs, const optional<T>& rhs) {
|
||||||
|
return rhs.has_value() ? lhs < rhs.value() : false;
|
||||||
|
}
|
||||||
|
template <class T, class U> inline constexpr bool operator<=(const optional<T>& lhs, const U& rhs) {
|
||||||
|
return lhs.has_value() ? lhs.value() <= lhs : true;
|
||||||
|
}
|
||||||
|
template <class T, class U> inline constexpr bool operator<=(const U& lhs, const optional<T>& rhs) {
|
||||||
|
return rhs.has_value() ? lhs <= rhs.value() : false;
|
||||||
|
}
|
||||||
|
template <class T, class U> inline constexpr bool operator>(const optional<T>& lhs, const U& rhs) {
|
||||||
|
return lhs.has_value() ? lhs.value() > lhs : false;
|
||||||
|
}
|
||||||
|
template <class T, class U> inline constexpr bool operator>(const U& lhs, const optional<T>& rhs) {
|
||||||
|
return rhs.has_value() ? lhs > rhs.value() : true;
|
||||||
|
}
|
||||||
|
template <class T, class U> inline constexpr bool operator>=(const optional<T>& lhs, const U& rhs) {
|
||||||
|
return lhs.has_value() ? lhs.value() >= lhs : false;
|
||||||
|
}
|
||||||
|
template <class T, class U> inline constexpr bool operator>=(const U& lhs, const optional<T>& rhs) {
|
||||||
|
return rhs.has_value() ? lhs >= rhs.value() : true;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// [optional.specalg], specialized algorithms
|
||||||
|
template <class T, tl::enable_if_t<std::is_move_constructible<T>::value* = nullptr,
|
||||||
|
tl:enable_if_t<std::is_swappable_v<T>>* = nullptr>
|
||||||
|
void swap(optional<T>& lhs, optional<T>& rhs) noexcept(noexcept(lhs.swap(rhs))) {
|
||||||
|
return lhs.swap(rhs);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <class T>
|
||||||
|
inline constexpr optional<tl::decay_t<T>> make_optional(T&& v) {
|
||||||
|
return optional<decay_t<T>>(std::forward<T>(v));
|
||||||
|
}
|
||||||
|
template <class T, class... Args>
|
||||||
|
inline constexpr optional<T> make_optional(Args&&... args) {
|
||||||
|
return optional<T>(in_place, std::forward<Args>(args)...);
|
||||||
|
}
|
||||||
|
template <class T, class U, class... Args>
|
||||||
|
inline constexpr optional<T> make_optional(initializer_list<U> il, Args&&... args) {
|
||||||
|
return optional<T>(in_place, il, std::forward<Args>(args)...);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// [optional.hash], hash support
|
||||||
|
namespace std {
|
||||||
|
template <class T> struct hash;
|
||||||
|
template <class T, class = decltype(hash<tl::remove_const_t<T>>{})>
|
||||||
|
struct hash<tl::optional<T>> {
|
||||||
|
std::size_t operator() (const tl::optional<T>& o) {
|
||||||
|
if (!o.has_value())
|
||||||
|
return 0;
|
||||||
|
|
||||||
|
return hash<tl::remove_const_t<T>>()(o.value());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
namespace tl {
|
||||||
|
|
||||||
|
template <class T>
|
||||||
|
class optional {
|
||||||
|
public:
|
||||||
|
using value_type = T;
|
||||||
|
|
||||||
|
// [optional.ctor], constructors
|
||||||
|
constexpr optional() noexcept : m_has_value(false) {
|
||||||
|
new (&m_storage.d) dummy;
|
||||||
|
}
|
||||||
|
constexpr optional(nullopt_t) noexcept : optional() {}
|
||||||
|
|
||||||
|
constexpr optional(const optional& rhs);
|
||||||
|
constexpr optional(optional&&) noexcept(see below);
|
||||||
|
template <class... Args>
|
||||||
|
constexpr explicit optional(in_place_t, Args&&...);
|
||||||
|
template <class U, class... Args>
|
||||||
|
constexpr explicit optional(in_place_t, initializer_list<U>, Args&&...);
|
||||||
|
template <class U = T>
|
||||||
|
EXPLICIT constexpr optional(U&&);
|
||||||
|
template <class U>
|
||||||
|
EXPLICIT optional(const optional<U>&);
|
||||||
|
template <class U>
|
||||||
|
EXPLICIT optional(optional<U>&&);
|
||||||
|
|
||||||
|
// [optional.dtor], destructor
|
||||||
|
~optional();
|
||||||
|
|
||||||
|
// [optional.assign], assignment
|
||||||
|
optional& operator=(nullopt_t) noexcept;
|
||||||
|
optional& operator=(const optional&);
|
||||||
|
optional& operator=(optional&&) noexcept(see below);
|
||||||
|
template <class U = T> optional& operator=(U&&);
|
||||||
|
template <class U> optional& operator=(const optional<U>&);
|
||||||
|
template <class U> optional& operator=(optional<U>&&);
|
||||||
|
template <class... Args> T& emplace(Args&&...);
|
||||||
|
template <class U, class... Args> T& emplace(initializer_list<U>, Args&&...);
|
||||||
|
|
||||||
|
// [optional.swap], swap
|
||||||
|
void swap(optional&) noexcept(see below);
|
||||||
|
|
||||||
|
// [optional.observe], observers
|
||||||
|
constexpr const T* operator->() const {
|
||||||
|
return std::addressof(m_storage.t);
|
||||||
|
}
|
||||||
|
constexpr T* operator->() {
|
||||||
|
return std::addressof(m_storage.t);
|
||||||
|
}
|
||||||
|
constexpr const T& operator*() const& {
|
||||||
|
return m_storage.t;
|
||||||
|
}
|
||||||
|
constexpr T& operator*() & {
|
||||||
|
return m_storage.t;
|
||||||
|
}
|
||||||
|
constexpr T&& operator*() && {
|
||||||
|
return std::move(m_storage.t);
|
||||||
|
}
|
||||||
|
constexpr const T&& operator*() const&& {
|
||||||
|
return std::move(m_storage.t);
|
||||||
|
}
|
||||||
|
constexpr explicit operator bool() const noexcept {
|
||||||
|
return m_has_value;
|
||||||
|
}
|
||||||
|
constexpr bool has_value() const noexcept {
|
||||||
|
return m_has_value;
|
||||||
|
}
|
||||||
|
constexpr const T& value() const& {
|
||||||
|
return has_value() ? m_storage.t : throw bad_optional_access();
|
||||||
|
}
|
||||||
|
constexpr T& value() & {
|
||||||
|
return has_value() ? m_storage.t : throw bad_optional_access();
|
||||||
|
}
|
||||||
|
constexpr T&& value() && {
|
||||||
|
return has_value() ? std::move(m_storage.t) : throw bad_optional_access();
|
||||||
|
}
|
||||||
|
constexpr const T&& value() const&& {
|
||||||
|
return has_value() ? std::move(m_storage.t) : throw bad_optional_access();
|
||||||
|
}
|
||||||
|
template <class U> constexpr T value_or(U&&) const& {
|
||||||
|
static_assert(std::is_copy_constructible<T>::value && std::is_convertible<U&&, T>::value,
|
||||||
|
"T must be copy constructible and convertible from U");
|
||||||
|
return has_value() ? value() : static_cast<T>(std::forward<U>(v));
|
||||||
|
}
|
||||||
|
template <class U> constexpr T value_or(U&&) && {
|
||||||
|
static_assert(std::is_move_constructible<T>::value && std::is_convertible<U&&, T>::value,
|
||||||
|
"T must be move constructible and convertible from U");
|
||||||
|
return has_value() ? value() : static_cast<T>(std::forward<U>(v));
|
||||||
|
}
|
||||||
|
|
||||||
|
// [optional.mod], modifiers
|
||||||
|
void reset() noexcept;
|
||||||
|
|
||||||
|
private:
|
||||||
|
struct dummy{};
|
||||||
|
union {
|
||||||
|
dummy d;
|
||||||
|
T t;
|
||||||
|
} m_storage;
|
||||||
|
|
||||||
|
bool m_has_value;
|
||||||
|
};
|
||||||
|
}
|
Reference in New Issue
Block a user