mfbt/MaybeOneOf.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_MaybeOneOf_h
   8 #define mozilla_MaybeOneOf_h
   9
  10 #include "mozilla/Alignment.h"
  11 #include "mozilla/Assertions.h"
  12 #include "mozilla/Move.h"
  13 #include "mozilla/TemplateLib.h"
  14
  15 #include <new>    // For placement new
  16
  17 namespace mozilla {
  18
  19 /*
  20  * MaybeOneOf<T1, T2> is like Maybe, but it supports constructing either T1
  21  * or T2. When a MaybeOneOf<T1, T2> is constructed, it is |empty()|, i.e.,
  22  * no value has been constructed and no destructor will be called when the
  23  * MaybeOneOf<T1, T2> is destroyed. Upon calling |construct<T1>()| or
  24  * |construct<T2>()|, a T1 or T2 object will be constructed with the given
  25  * arguments and that object will be destroyed when the owning MaybeOneOf is
  26  * destroyed.
  27  */
  28 template<class T1, class T2>
  29 class MaybeOneOf
  30 {
  31   AlignedStorage<tl::Max<sizeof(T1), sizeof(T2)>::value> storage;
  32
  33   enum State { None, SomeT1, SomeT2 } state;
  34   template <class T, class Ignored = void> struct Type2State {};
  35
  36   template <class T>
  37   T& as()
  38   {
  39     MOZ_ASSERT(state == Type2State<T>::result);
  40     return *(T*)storage.addr();
  41   }
  42
  43   template <class T>
  44   const T& as() const
  45   {
  46     MOZ_ASSERT(state == Type2State<T>::result);
  47     return *(T*)storage.addr();
  48   }
  49
  50 public:
  51   MaybeOneOf() : state(None) {}
  52   ~MaybeOneOf() { destroyIfConstructed(); }
  53
  54   bool empty() const { return state == None; }
  55
  56   template <class T>
  57   bool constructed() const { return state == Type2State<T>::result; }
  58
  59   template <class T>
  60   void construct()
  61   {
  62     MOZ_ASSERT(state == None);
  63     state = Type2State<T>::result;
  64     ::new (storage.addr()) T();
  65   }
  66
  67   template <class T, class U>
  68   void construct(U&& aU)
  69   {
  70     MOZ_ASSERT(state == None);
  71     state = Type2State<T>::result;
  72     ::new (storage.addr()) T(Move(aU));
  73   }
  74
  75   template <class T, class U1>
  76   void construct(const U1& aU1)
  77   {
  78     MOZ_ASSERT(state == None);
  79     state = Type2State<T>::result;
  80     ::new (storage.addr()) T(aU1);
  81   }
  82
  83   template <class T, class U1, class U2>
  84   void construct(const U1& aU1, const U2& aU2)
  85   {
  86     MOZ_ASSERT(state == None);
  87     state = Type2State<T>::result;
  88     ::new (storage.addr()) T(aU1, aU2);
  89   }
  90
  91   template <class T>
  92   T& ref()
  93   {
  94     return as<T>();
  95   }
  96
  97   template <class T>
  98   const T& ref() const
  99   {
 100     return as<T>();
 101   }
 102
 103   void destroy()
 104   {
 105     MOZ_ASSERT(state == SomeT1 || state == SomeT2);
 106     if (state == SomeT1) {
 107       as<T1>().~T1();
 108     } else if (state == SomeT2) {
 109       as<T2>().~T2();
 110     }
 111     state = None;
 112   }
 113
 114   void destroyIfConstructed()
 115   {
 116     if (!empty()) {
 117       destroy();
 118     }
 119   }
 120
 121 private:
 122   MaybeOneOf(const MaybeOneOf& aOther) MOZ_DELETE;
 123   const MaybeOneOf& operator=(const MaybeOneOf& aOther) MOZ_DELETE;
 124 };
 125
 126 template <class T1, class T2>
 127 template <class Ignored>
 128 struct MaybeOneOf<T1, T2>::Type2State<T1, Ignored>
 129 {
 130   typedef MaybeOneOf<T1, T2> Enclosing;
 131   static const typename Enclosing::State result = Enclosing::SomeT1;
 132 };
 133
 134 template <class T1, class T2>
 135 template <class Ignored>
 136 struct MaybeOneOf<T1, T2>::Type2State<T2, Ignored>
 137 {
 138   typedef MaybeOneOf<T1, T2> Enclosing;
 139   static const typename Enclosing::State result = Enclosing::SomeT2;
 140 };
 141
 142 } // namespace mozilla
 143
 144 #endif /* mozilla_MaybeOneOf_h */