folly/Optional.h

   1 /*
   2  * Copyright 2012 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef FOLLY_OPTIONAL_H_
  18 #define FOLLY_OPTIONAL_H_
  19
  20 /*
  21  * Optional - For conditional initialization of values, like boost::optional,
  22  * but with support for move semantics and emplacement.  Reference type support
  23  * has not been included due to limited use cases and potential confusion with
  24  * semantics of assignment: Assigning to an optional reference could quite
  25  * reasonably copy its value or redirect the reference.
  26  *
  27  * Optional can be useful when a variable might or might not be needed:
  28  *
  29  *  Optional<Logger> maybeLogger = ...;
  30  *  if (maybeLogger) {
  31  *    maybeLogger->log("hello");
  32  *  }
  33  *
  34  * Optional enables a 'null' value for types which do not otherwise have
  35  * nullability, especially useful for parameter passing:
  36  *
  37  * void testIterator(const unique_ptr<Iterator>& it,
  38  *                   initializer_list<int> idsExpected,
  39  *                   Optional<initializer_list<int>> ranksExpected = none) {
  40  *   for (int i = 0; it->next(); ++i) {
  41  *     EXPECT_EQ(it->doc().id(), idsExpected[i]);
  42  *     if (ranksExpected) {
  43  *       EXPECT_EQ(it->doc().rank(), (*ranksExpected)[i]);
  44  *     }
  45  *   }
  46  * }
  47  *
  48  * Optional models OptionalPointee, so calling 'get_pointer(opt)' will return a
  49  * pointer to nullptr if the 'opt' is empty, and a pointer to the value if it is
  50  * not:
  51  *
  52  *  Optional<int> maybeInt = ...;
  53  *  if (int* v = get_pointer(maybeInt)) {
  54  *    cout << *v << endl;
  55  *  }
  56  */
  57 #include <utility>
  58 #include <cassert>
  59 #include <cstddef>
  60 #include <type_traits>
  61
  62 #include <boost/operators.hpp>
  63
  64 namespace folly {
  65
  66 namespace detail { struct NoneHelper {}; }
  67
  68 typedef int detail::NoneHelper::*None;
  69
  70 const None none = nullptr;
  71
  72 /**
  73  * gcc-4.7 warns about use of uninitialized memory around the use of storage_
  74  * even though this is explicitly initialized at each point.
  75  */
  76 #pragma GCC diagnostic push
  77 #pragma GCC diagnostic ignored "-Wuninitialized"
  78
  79 template<class Value>
  80 class Optional : boost::totally_ordered<Optional<Value>,
  81                  boost::totally_ordered<Optional<Value>, Value>> {
  82   typedef void (Optional::*bool_type)() const;
  83   void truthy() const {};
  84  public:
  85   static_assert(!std::is_reference<Value>::value,
  86                 "Optional may not be used with reference types");
  87
  88   Optional()
  89     : hasValue_(false) {
  90   }
  91
  92   Optional(const Optional& src) {
  93     construct(src.value());
  94   }
  95
  96   Optional(Optional&& src) {
  97     construct(std::move(src.value()));
  98     src.clear();
  99   }
 100
 101   /* implicit */ Optional(const None& empty)
 102     : hasValue_(false) {
 103   }
 104
 105   /* implicit */ Optional(Value&& newValue) {
 106     construct(std::move(newValue));
 107   }
 108
 109   /* implicit */ Optional(const Value& newValue) {
 110     construct(newValue);
 111   }
 112
 113   ~Optional() {
 114     clear();
 115   }
 116
 117   void assign(const None&) {
 118     clear();
 119   }
 120
 121   void assign(Optional&& src) {
 122     if (src.hasValue()) {
 123       assign(std::move(src.value()));
 124       src.clear();
 125     } else {
 126       clear();
 127     }
 128   }
 129
 130   void assign(const Optional& src) {
 131     if (src.hasValue()) {
 132       assign(src.value());
 133     } else {
 134       clear();
 135     }
 136   }
 137
 138   void assign(Value&& newValue) {
 139     if (hasValue()) {
 140       value_ = std::move(newValue);
 141     } else {
 142       construct(std::move(newValue));
 143     }
 144   }
 145
 146   void assign(const Value& newValue) {
 147     if (hasValue()) {
 148       value_ = newValue;
 149     } else {
 150       construct(newValue);
 151     }
 152   }
 153
 154   template<class Arg>
 155   Optional& operator=(Arg&& arg) {
 156     assign(std::forward<Arg>(arg));
 157     return *this;
 158   }
 159
 160   bool operator<(const Optional& other) const {
 161     if (hasValue() != other.hasValue()) {
 162       return hasValue() < other.hasValue();
 163     }
 164     if (hasValue()) {
 165       return value() < other.value();
 166     }
 167     return false; // both empty
 168   }
 169
 170   bool operator<(const Value& other) const {
 171     return !hasValue() || value() < other;
 172   }
 173
 174   bool operator==(const Optional& other) const {
 175     if (hasValue()) {
 176       return other.hasValue() && value() == other.value();
 177     } else {
 178       return !other.hasValue();
 179     }
 180   }
 181
 182   bool operator==(const Value& other) const {
 183     return hasValue() && value() == other;
 184   }
 185
 186   template<class... Args>
 187   void emplace(Args&&... args) {
 188     clear();
 189     construct(std::forward<Args>(args)...);
 190   }
 191
 192   void clear() {
 193     if (hasValue()) {
 194       hasValue_ = false;
 195       value().~Value();
 196     }
 197   }
 198
 199   const Value& value() const {
 200     assert(hasValue());
 201     return value_;
 202   }
 203
 204   Value& value() {
 205     assert(hasValue());
 206     return value_;
 207   }
 208
 209   bool hasValue() const { return hasValue_; }
 210
 211   /* safe bool idiom */
 212   operator bool_type() const {
 213     return hasValue() ? &Optional::truthy : nullptr;
 214   }
 215
 216   const Value& operator*() const { return value(); }
 217         Value& operator*()       { return value(); }
 218
 219   const Value* operator->() const { return &value(); }
 220         Value* operator->()       { return &value(); }
 221
 222  private:
 223   template<class... Args>
 224   void construct(Args&&... args) {
 225     const void* ptr = &value_;
 226     // for supporting const types
 227     new(const_cast<void*>(ptr)) Value(std::forward<Args>(args)...);
 228     hasValue_ = true;
 229   }
 230
 231   // uninitialized
 232   union { Value value_; };
 233   bool hasValue_;
 234 };
 235
 236 #pragma GCC diagnostic pop
 237
 238 template<class T>
 239 const T* get_pointer(const Optional<T>& opt) {
 240   return opt ? &opt.value() : nullptr;
 241 }
 242
 243 template<class T>
 244 T* get_pointer(Optional<T>& opt) {
 245   return opt ? &opt.value() : nullptr;
 246 }
 247
 248 template<class T>
 249 void swap(Optional<T>& a, Optional<T>& b) {
 250   if (a.hasValue() && b.hasValue()) {
 251     // both full
 252     using std::swap;
 253     swap(a.value(), b.value());
 254   } else if (a.hasValue() || b.hasValue()) {
 255     std::swap(a, b); // fall back to default implementation if they're mixed.
 256   }
 257 }
 258
 259 }// namespace folly
 260
 261 #endif//FOLLY_OPTIONAL_H_