include/llvm/ADT/OwningPtr.h

   1 //===- llvm/ADT/OwningPtr.h - Smart ptr that owns the pointee ---*- 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 defines and implements the OwningPtr class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ADT_OWNINGPTR_H
  15 #define LLVM_ADT_OWNINGPTR_H
  16
  17 #include "llvm/Support/Compiler.h"
  18 #include <cassert>
  19 #include <cstddef>
  20 #include <memory>
  21
  22 namespace llvm {
  23
  24 /// OwningPtr smart pointer - OwningPtr mimics a built-in pointer except that it
  25 /// guarantees deletion of the object pointed to, either on destruction of the
  26 /// OwningPtr or via an explicit reset().  Once created, ownership of the
  27 /// pointee object can be taken away from OwningPtr by using the take method.
  28 template<class T>
  29 class OwningPtr {
  30   OwningPtr(OwningPtr const &) LLVM_DELETED_FUNCTION;
  31   OwningPtr &operator=(OwningPtr const &) LLVM_DELETED_FUNCTION;
  32   T *Ptr;
  33 public:
  34   explicit OwningPtr(T *P = 0) : Ptr(P) {}
  35
  36   OwningPtr(OwningPtr &&Other) : Ptr(Other.take()) {}
  37
  38   OwningPtr &operator=(OwningPtr &&Other) {
  39     reset(Other.take());
  40     return *this;
  41   }
  42
  43   OwningPtr(std::unique_ptr<T> Other) : Ptr(Other.release()) {}
  44
  45   OwningPtr &operator=(std::unique_ptr<T> Other) {
  46     reset(Other.release());
  47     return *this;
  48   }
  49
  50 #if LLVM_HAS_RVALUE_REFERENCE_THIS
  51   operator std::unique_ptr<T>() && { return std::unique_ptr<T>(take()); }
  52 #endif
  53
  54   ~OwningPtr() {
  55     delete Ptr;
  56   }
  57
  58   /// reset - Change the current pointee to the specified pointer.  Note that
  59   /// calling this with any pointer (including a null pointer) deletes the
  60   /// current pointer.
  61   void reset(T *P = 0) {
  62     if (P == Ptr) return;
  63     T *Tmp = Ptr;
  64     Ptr = P;
  65     delete Tmp;
  66   }
  67
  68   /// take - Reset the owning pointer to null and return its pointer.  This does
  69   /// not delete the pointer before returning it.
  70   T *take() {
  71     T *Tmp = Ptr;
  72     Ptr = 0;
  73     return Tmp;
  74   }
  75
  76   std::unique_ptr<T> take_unique() { return std::unique_ptr<T>(take()); }
  77
  78   T &operator*() const {
  79     assert(Ptr && "Cannot dereference null pointer");
  80     return *Ptr;
  81   }
  82
  83   T *operator->() const { return Ptr; }
  84   T *get() const { return Ptr; }
  85   LLVM_EXPLICIT operator bool() const { return Ptr != 0; }
  86   bool operator!() const { return Ptr == 0; }
  87   bool isValid() const { return Ptr != 0; }
  88
  89   void swap(OwningPtr &RHS) {
  90     T *Tmp = RHS.Ptr;
  91     RHS.Ptr = Ptr;
  92     Ptr = Tmp;
  93   }
  94 };
  95
  96 template<class T>
  97 inline void swap(OwningPtr<T> &a, OwningPtr<T> &b) {
  98   a.swap(b);
  99 }
 100
 101 /// OwningArrayPtr smart pointer - OwningArrayPtr provides the same
 102 ///  functionality as OwningPtr, except that it works for array types.
 103 template<class T>
 104 class OwningArrayPtr {
 105   OwningArrayPtr(OwningArrayPtr const &) LLVM_DELETED_FUNCTION;
 106   OwningArrayPtr &operator=(OwningArrayPtr const &) LLVM_DELETED_FUNCTION;
 107   T *Ptr;
 108 public:
 109   explicit OwningArrayPtr(T *P = 0) : Ptr(P) {}
 110
 111   OwningArrayPtr(OwningArrayPtr &&Other) : Ptr(Other.take()) {}
 112
 113   OwningArrayPtr &operator=(OwningArrayPtr &&Other) {
 114     reset(Other.take());
 115     return *this;
 116   }
 117
 118   ~OwningArrayPtr() {
 119     delete [] Ptr;
 120   }
 121
 122   /// reset - Change the current pointee to the specified pointer.  Note that
 123   /// calling this with any pointer (including a null pointer) deletes the
 124   /// current pointer.
 125   void reset(T *P = 0) {
 126     if (P == Ptr) return;
 127     T *Tmp = Ptr;
 128     Ptr = P;
 129     delete [] Tmp;
 130   }
 131
 132   /// take - Reset the owning pointer to null and return its pointer.  This does
 133   /// not delete the pointer before returning it.
 134   T *take() {
 135     T *Tmp = Ptr;
 136     Ptr = 0;
 137     return Tmp;
 138   }
 139
 140   T &operator[](std::ptrdiff_t i) const {
 141     assert(Ptr && "Cannot dereference null pointer");
 142     return Ptr[i];
 143   }
 144
 145   T *get() const { return Ptr; }
 146   LLVM_EXPLICIT operator bool() const { return Ptr != 0; }
 147   bool operator!() const { return Ptr == 0; }
 148
 149   void swap(OwningArrayPtr &RHS) {
 150     T *Tmp = RHS.Ptr;
 151     RHS.Ptr = Ptr;
 152     Ptr = Tmp;
 153   }
 154 };
 155
 156 template<class T>
 157 inline void swap(OwningArrayPtr<T> &a, OwningArrayPtr<T> &b) {
 158   a.swap(b);
 159 }
 160
 161 } // end namespace llvm
 162
 163 #endif