include/llvm/ADT/Optional.h

   1 //===-- Optional.h - Simple variant for passing optional values ---*- C++ -*-=//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This file provides Optional, a template class modeled in the spirit of
  11 //  OCaml's 'opt' variant.  The idea is to strongly type whether or not
  12 //  a value can be optional.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_ADT_OPTIONAL
  17 #define LLVM_ADT_OPTIONAL
  18
  19 #include <cassert>
  20
  21 namespace llvm {
  22
  23 template<typename T>
  24 class Optional {
  25   T x;
  26   unsigned hasVal : 1;
  27 public:
  28   explicit Optional() : x(), hasVal(false) {}
  29   Optional(const T &y) : x(y), hasVal(true) {}
  30
  31   static inline Optional create(const T* y) {
  32     return y ? Optional(*y) : Optional();
  33   }
  34
  35   Optional &operator=(const T &y) {
  36     x = y;
  37     hasVal = true;
  38     return *this;
  39   }
  40
  41   const T* getPointer() const { assert(hasVal); return &x; }
  42   const T& getValue() const { assert(hasVal); return x; }
  43
  44   operator bool() const { return hasVal; }
  45   bool hasValue() const { return hasVal; }
  46   const T* operator->() const { return getPointer(); }
  47   const T& operator*() const { assert(hasVal); return x; }
  48 };
  49
  50 template<typename T> struct simplify_type;
  51
  52 template <typename T>
  53 struct simplify_type<const Optional<T> > {
  54   typedef const T* SimpleType;
  55   static SimpleType getSimplifiedValue(const Optional<T> &Val) {
  56     return Val.getPointer();
  57   }
  58 };
  59
  60 template <typename T>
  61 struct simplify_type<Optional<T> >
  62   : public simplify_type<const Optional<T> > {};
  63
  64 } // end llvm namespace
  65
  66 #endif