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_OWNING_PTR_H
15 #define LLVM_ADT_OWNING_PTR_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) {}
39 /// reset - Change the current pointee to the specified pointer. Note that
40 /// calling this with any pointer (including a null pointer) deletes the
42 void reset(T *P = 0) {
49 /// take - Reset the owning pointer to null and return its pointer. This does
50 /// not delete the pointer before returning it.
57 T &operator*() const {
58 assert(Ptr && "Cannot dereference null pointer");
62 T *operator->() const { return Ptr; }
63 T *get() const { return Ptr; }
64 operator bool() const { return Ptr != 0; }
65 bool operator!() const { return Ptr == 0; }
67 void swap(OwningPtr &RHS) {
75 inline void swap(OwningPtr<T> &a, OwningPtr<T> &b) {
79 /// OwningArrayPtr smart pointer - OwningArrayPtr provides the same
80 /// functionality as OwningPtr, except that it works for array types.
82 class OwningArrayPtr {
83 OwningArrayPtr(OwningArrayPtr const &) LLVM_DELETED_FUNCTION;
84 OwningArrayPtr &operator=(OwningArrayPtr const &) LLVM_DELETED_FUNCTION;
87 explicit OwningArrayPtr(T *P = 0) : Ptr(P) {}
93 /// reset - Change the current pointee to the specified pointer. Note that
94 /// calling this with any pointer (including a null pointer) deletes the
96 void reset(T *P = 0) {
103 /// take - Reset the owning pointer to null and return its pointer. This does
104 /// not delete the pointer before returning it.
111 T &operator[](std::ptrdiff_t i) const {
112 assert(Ptr && "Cannot dereference null pointer");
116 T *get() const { return Ptr; }
117 operator bool() const { return Ptr != 0; }
118 bool operator!() const { return Ptr == 0; }
120 void swap(OwningArrayPtr &RHS) {
128 inline void swap(OwningArrayPtr<T> &a, OwningArrayPtr<T> &b) {
132 } // end namespace llvm