1 //===- llvm/ADT/OwningPtr.h - Smart ptr that owns the pointee ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines and implements the OwningPtr class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ADT_OWNINGPTR_H
15 #define LLVM_ADT_OWNINGPTR_H
17 #include "llvm/Support/Compiler.h"
23 /// OwningPtr smart pointer - OwningPtr mimics a built-in pointer except that it
24 /// guarantees deletion of the object pointed to, either on destruction of the
25 /// OwningPtr or via an explicit reset(). Once created, ownership of the
26 /// pointee object can be taken away from OwningPtr by using the take method.
29 OwningPtr(OwningPtr const &) LLVM_DELETED_FUNCTION;
30 OwningPtr &operator=(OwningPtr const &) LLVM_DELETED_FUNCTION;
33 explicit OwningPtr(T *P = 0) : Ptr(P) {}
35 #if LLVM_HAS_RVALUE_REFERENCES
36 OwningPtr(OwningPtr &&Other) : Ptr(Other.take()) {}
38 OwningPtr &operator=(OwningPtr &&Other) {
48 /// reset - Change the current pointee to the specified pointer. Note that
49 /// calling this with any pointer (including a null pointer) deletes the
51 void reset(T *P = 0) {
58 /// take - Reset the owning pointer to null and return its pointer. This does
59 /// not delete the pointer before returning it.
66 T &operator*() const {
67 assert(Ptr && "Cannot dereference null pointer");
71 T *operator->() const { return Ptr; }
72 T *get() const { return Ptr; }
73 LLVM_EXPLICIT operator bool() const { return Ptr != 0; }
74 bool operator!() const { return Ptr == 0; }
75 bool isValid() const { return Ptr != 0; }
77 void swap(OwningPtr &RHS) {
85 inline void swap(OwningPtr<T> &a, OwningPtr<T> &b) {
89 /// OwningArrayPtr smart pointer - OwningArrayPtr provides the same
90 /// functionality as OwningPtr, except that it works for array types.
92 class OwningArrayPtr {
93 OwningArrayPtr(OwningArrayPtr const &) LLVM_DELETED_FUNCTION;
94 OwningArrayPtr &operator=(OwningArrayPtr const &) LLVM_DELETED_FUNCTION;
97 explicit OwningArrayPtr(T *P = 0) : Ptr(P) {}
99 #if LLVM_HAS_RVALUE_REFERENCES
100 OwningArrayPtr(OwningArrayPtr &&Other) : Ptr(Other.take()) {}
102 OwningArrayPtr &operator=(OwningArrayPtr &&Other) {
112 /// reset - Change the current pointee to the specified pointer. Note that
113 /// calling this with any pointer (including a null pointer) deletes the
115 void reset(T *P = 0) {
116 if (P == Ptr) return;
122 /// take - Reset the owning pointer to null and return its pointer. This does
123 /// not delete the pointer before returning it.
130 T &operator[](std::ptrdiff_t i) const {
131 assert(Ptr && "Cannot dereference null pointer");
135 T *get() const { return Ptr; }
136 LLVM_EXPLICIT operator bool() const { return Ptr != 0; }
137 bool operator!() const { return Ptr == 0; }
139 void swap(OwningArrayPtr &RHS) {
147 inline void swap(OwningArrayPtr<T> &a, OwningArrayPtr<T> &b) {
151 } // end namespace llvm