/*
- * Copyright 2014 Facebook, Inc.
+ * Copyright 2015 Facebook, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* cout << *v << endl;
* }
*/
-#include <utility>
-#include <cassert>
#include <cstddef>
+#include <stdexcept>
#include <type_traits>
+#include <utility>
#include <boost/operators.hpp>
+#include <folly/Portability.h>
namespace folly {
# pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
#endif // __GNUC__
+class OptionalEmptyException : public std::runtime_error {
+ public:
+ OptionalEmptyException()
+ : std::runtime_error("Empty Optional cannot be unwrapped") {}
+};
+
template<class Value>
class Optional {
public:
+ typedef Value value_type;
+
static_assert(!std::is_reference<Value>::value,
"Optional may not be used with reference types");
+ static_assert(!std::is_abstract<Value>::value,
+ "Optional may not be used with abstract types");
- Optional()
+ Optional() noexcept
: hasValue_(false) {
}
}
}
- /* implicit */ Optional(const None&)
+ /* implicit */ Optional(const None&) noexcept
: hasValue_(false) {
}
- /* implicit */ Optional(Value&& newValue) {
+ /* implicit */ Optional(Value&& newValue)
+ noexcept(std::is_nothrow_move_constructible<Value>::value) {
construct(std::move(newValue));
}
- /* implicit */ Optional(const Value& newValue) {
+ /* implicit */ Optional(const Value& newValue)
+ noexcept(std::is_nothrow_copy_constructible<Value>::value) {
construct(newValue);
}
}
void assign(Optional&& src) {
- if (src.hasValue()) {
- assign(std::move(src.value()));
- src.clear();
- } else {
- clear();
+ if (this != &src) {
+ if (src.hasValue()) {
+ assign(std::move(src.value()));
+ src.clear();
+ } else {
+ clear();
+ }
}
}
}
}
- const Value& value() const {
- assert(hasValue());
+ const Value& value() const& {
+ require_value();
return value_;
}
- Value& value() {
- assert(hasValue());
+ Value& value() & {
+ require_value();
return value_;
}
+ Value value() && {
+ require_value();
+ return std::move(value_);
+ }
+
+ const Value* get_pointer() const& { return hasValue_ ? &value_ : nullptr; }
+ Value* get_pointer() & { return hasValue_ ? &value_ : nullptr; }
+ Value* get_pointer() && = delete;
+
bool hasValue() const { return hasValue_; }
explicit operator bool() const {
return hasValue();
}
- const Value& operator*() const { return value(); }
- Value& operator*() { return value(); }
+ const Value& operator*() const& { return value(); }
+ Value& operator*() & { return value(); }
+ Value operator*() && { return std::move(value()); }
const Value* operator->() const { return &value(); }
Value* operator->() { return &value(); }
+ // Return a copy of the value if set, or a given default if not.
+ template <class U>
+ Value value_or(U&& dflt) const& {
+ return hasValue_ ? value_ : std::forward<U>(dflt);
+ }
+
+ template <class U>
+ Value value_or(U&& dflt) && {
+ return hasValue_ ? std::move(value_) : std::forward<U>(dflt);
+ }
+
private:
+ void require_value() const {
+ if (!hasValue_) {
+ throw OptionalEmptyException();
+ }
+ }
+
template<class... Args>
void construct(Args&&... args) {
const void* ptr = &value_;
template<class T>
const T* get_pointer(const Optional<T>& opt) {
- return opt ? &opt.value() : nullptr;
+ return opt.get_pointer();
}
template<class T>
T* get_pointer(Optional<T>& opt) {
- return opt ? &opt.value() : nullptr;
+ return opt.get_pointer();
}
template<class T>
return Opt(std::forward<T>(v));
}
+///////////////////////////////////////////////////////////////////////////////
+// Comparisons.
+
template<class V>
-bool operator< (const Optional<V>& a, const Optional<V>& b) {
- if (a.hasValue() != b.hasValue()) { return a.hasValue() < b.hasValue(); }
- if (a.hasValue()) { return a.value() < b.value(); }
- return false;
+bool operator==(const Optional<V>& a, const V& b) {
+ return a.hasValue() && a.value() == b;
+}
+
+template<class V>
+bool operator!=(const Optional<V>& a, const V& b) {
+ return !(a == b);
+}
+
+template<class V>
+bool operator==(const V& a, const Optional<V>& b) {
+ return b.hasValue() && b.value() == a;
+}
+
+template<class V>
+bool operator!=(const V& a, const Optional<V>& b) {
+ return !(a == b);
}
template<class V>
return true;
}
-template<class V>
-bool operator<=(const Optional<V>& a, const Optional<V>& b) {
- return !(b < a);
-}
-
template<class V>
bool operator!=(const Optional<V>& a, const Optional<V>& b) {
- return !(b == a);
+ return !(a == b);
}
template<class V>
-bool operator>=(const Optional<V>& a, const Optional<V>& b) {
- return !(a < b);
+bool operator< (const Optional<V>& a, const Optional<V>& b) {
+ if (a.hasValue() != b.hasValue()) { return a.hasValue() < b.hasValue(); }
+ if (a.hasValue()) { return a.value() < b.value(); }
+ return false;
}
template<class V>
return b < a;
}
-// To supress comparability of Optional<T> with T, despite implicit conversion.
+template<class V>
+bool operator<=(const Optional<V>& a, const Optional<V>& b) {
+ return !(b < a);
+}
+
+template<class V>
+bool operator>=(const Optional<V>& a, const Optional<V>& b) {
+ return !(a < b);
+}
+
+// Suppress comparability of Optional<T> with T, despite implicit conversion.
template<class V> bool operator< (const Optional<V>&, const V& other) = delete;
template<class V> bool operator<=(const Optional<V>&, const V& other) = delete;
-template<class V> bool operator==(const Optional<V>&, const V& other) = delete;
-template<class V> bool operator!=(const Optional<V>&, const V& other) = delete;
template<class V> bool operator>=(const Optional<V>&, const V& other) = delete;
template<class V> bool operator> (const Optional<V>&, const V& other) = delete;
template<class V> bool operator< (const V& other, const Optional<V>&) = delete;
template<class V> bool operator<=(const V& other, const Optional<V>&) = delete;
-template<class V> bool operator==(const V& other, const Optional<V>&) = delete;
-template<class V> bool operator!=(const V& other, const Optional<V>&) = delete;
template<class V> bool operator>=(const V& other, const Optional<V>&) = delete;
template<class V> bool operator> (const V& other, const Optional<V>&) = delete;
+///////////////////////////////////////////////////////////////////////////////
+
} // namespace folly
-#endif//FOLLY_OPTIONAL_H_
+#endif // FOLLY_OPTIONAL_H_