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 #pragma GCC diagnostic ignored "-Wpragmas"
  79 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
  80
  81 template<class Value>
  82 class Optional : boost::totally_ordered<Optional<Value>,
  83                  boost::totally_ordered<Optional<Value>, Value>> {
  84   typedef void (Optional::*bool_type)() const;
  85   void truthy() const {};
  86  public:
  87   static_assert(!std::is_reference<Value>::value,
  88                 "Optional may not be used with reference types");
  89
  90   Optional()
  91     : hasValue_(false) {
  92   }
  93
  94   Optional(const Optional& src) {
  95     if (src.hasValue()) {
  96       construct(src.value());
  97     } else {
  98       hasValue_ = false;
  99     }
 100   }
 101
 102   Optional(Optional&& src) {
 103     if (src.hasValue()) {
 104       construct(std::move(src.value()));
 105       src.clear();
 106     } else {
 107       hasValue_ = false;
 108     }
 109   }
 110
 111   /* implicit */ Optional(const None& empty)
 112     : hasValue_(false) {
 113   }
 114
 115   /* implicit */ Optional(Value&& newValue) {
 116     construct(std::move(newValue));
 117   }
 118
 119   /* implicit */ Optional(const Value& newValue) {
 120     construct(newValue);
 121   }
 122
 123   ~Optional() {
 124     clear();
 125   }
 126
 127   void assign(const None&) {
 128     clear();
 129   }
 130
 131   void assign(Optional&& src) {
 132     if (src.hasValue()) {
 133       assign(std::move(src.value()));
 134       src.clear();
 135     } else {
 136       clear();
 137     }
 138   }
 139
 140   void assign(const Optional& src) {
 141     if (src.hasValue()) {
 142       assign(src.value());
 143     } else {
 144       clear();
 145     }
 146   }
 147
 148   void assign(Value&& newValue) {
 149     if (hasValue()) {
 150       value_ = std::move(newValue);
 151     } else {
 152       construct(std::move(newValue));
 153     }
 154   }
 155
 156   void assign(const Value& newValue) {
 157     if (hasValue()) {
 158       value_ = newValue;
 159     } else {
 160       construct(newValue);
 161     }
 162   }
 163
 164   template<class Arg>
 165   Optional& operator=(Arg&& arg) {
 166     assign(std::forward<Arg>(arg));
 167     return *this;
 168   }
 169
 170   bool operator<(const Optional& other) const {
 171     if (hasValue() != other.hasValue()) {
 172       return hasValue() < other.hasValue();
 173     }
 174     if (hasValue()) {
 175       return value() < other.value();
 176     }
 177     return false; // both empty
 178   }
 179
 180   bool operator<(const Value& other) const {
 181     return !hasValue() || value() < other;
 182   }
 183
 184   bool operator==(const Optional& other) const {
 185     if (hasValue()) {
 186       return other.hasValue() && value() == other.value();
 187     } else {
 188       return !other.hasValue();
 189     }
 190   }
 191
 192   bool operator==(const Value& other) const {
 193     return hasValue() && value() == other;
 194   }
 195
 196   template<class... Args>
 197   void emplace(Args&&... args) {
 198     clear();
 199     construct(std::forward<Args>(args)...);
 200   }
 201
 202   void clear() {
 203     if (hasValue()) {
 204       hasValue_ = false;
 205       value_.~Value();
 206     }
 207   }
 208
 209   const Value& value() const {
 210     assert(hasValue());
 211     return value_;
 212   }
 213
 214   Value& value() {
 215     assert(hasValue());
 216     return value_;
 217   }
 218
 219   bool hasValue() const { return hasValue_; }
 220
 221   /* safe bool idiom */
 222   operator bool_type() const {
 223     return hasValue() ? &Optional::truthy : nullptr;
 224   }
 225
 226   const Value& operator*() const { return value(); }
 227         Value& operator*()       { return value(); }
 228
 229   const Value* operator->() const { return &value(); }
 230         Value* operator->()       { return &value(); }
 231
 232  private:
 233   template<class... Args>
 234   void construct(Args&&... args) {
 235     const void* ptr = &value_;
 236     // for supporting const types
 237     new(const_cast<void*>(ptr)) Value(std::forward<Args>(args)...);
 238     hasValue_ = true;
 239   }
 240
 241   // uninitialized
 242   union { Value value_; };
 243   bool hasValue_;
 244 };
 245
 246 #pragma GCC diagnostic pop
 247
 248 template<class T>
 249 const T* get_pointer(const Optional<T>& opt) {
 250   return opt ? &opt.value() : nullptr;
 251 }
 252
 253 template<class T>
 254 T* get_pointer(Optional<T>& opt) {
 255   return opt ? &opt.value() : nullptr;
 256 }
 257
 258 template<class T>
 259 void swap(Optional<T>& a, Optional<T>& b) {
 260   if (a.hasValue() && b.hasValue()) {
 261     // both full
 262     using std::swap;
 263     swap(a.value(), b.value());
 264   } else if (a.hasValue() || b.hasValue()) {
 265     std::swap(a, b); // fall back to default implementation if they're mixed.
 266   }
 267 }
 268
 269 }// namespace folly
 270
 271 #endif//FOLLY_OPTIONAL_H_