1 //===- llvm/ADT/OwningPtr.h - Smart ptr that owns the pointee ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Chris Lattner and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines and implements the OwningPtr class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ADT_OWNING_PTR_H
15 #define LLVM_ADT_OWNING_PTR_H
21 /// OwningPtr smart pointer - OwningPtr mimics a built-in pointer except that it
22 /// guarantees deletion of the object pointed to, either on destruction of the
23 /// OwningPtr or via an explicit reset(). Once created, ownership of the
24 /// pointee object can be taken away from OwningPtr by using the take method.
27 OwningPtr(OwningPtr const &); // DO NOT IMPLEMENT
28 OwningPtr &operator=(OwningPtr const &); // DO NOT IMPLEMENT
31 explicit OwningPtr(T *P = 0) : Ptr(P) {}
37 /// reset - Change the current pointee to the specified pointer. Note that
38 /// calling this with any pointer (including a null pointer) deletes the
40 void reset(T *P = 0) {
47 /// take - Reset the owning pointer to null and return its pointer. This does
48 /// not delete the pointer before returning it.
55 T &operator*() const {
56 assert(Ptr && "Cannot dereference null pointer");
60 T *operator->() const { return Ptr; }
61 T *get() const { return Ptr; }
62 operator bool() const { return Ptr != 0; }
63 bool operator!() const { return Ptr == 0; }
65 void swap(OwningPtr &RHS) {
73 inline void swap(OwningPtr<T> &a, OwningPtr<T> &b) {
77 /// OwningArrayPtr smart pointer - OwningArrayPtr provides the same
78 /// functionality as OwningPtr, except that it works for array types.
80 class OwningArrayPtr {
81 OwningArrayPtr(OwningArrayPtr const &); // DO NOT IMPLEMENT
82 OwningArrayPtr &operator=(OwningArrayPtr const &); // DO NOT IMPLEMENT
85 explicit OwningArrayPtr(T *P = 0) : Ptr(P) {}
91 /// reset - Change the current pointee to the specified pointer. Note that
92 /// calling this with any pointer (including a null pointer) deletes the
94 void reset(T *P = 0) {
101 /// take - Reset the owning pointer to null and return its pointer. This does
102 /// not delete the pointer before returning it.
109 T &operator[](std::ptrdiff_t i) const {
110 assert(Ptr && "Cannot dereference null pointer");
114 T *get() const { return Ptr; }
115 operator bool() const { return Ptr != 0; }
116 bool operator!() const { return Ptr == 0; }
118 void swap(OwningArrayPtr &RHS) {
126 inline void swap(OwningArrayPtr<T> &a, OwningArrayPtr<T> &b) {
131 } // end namespace llvm