kmillikin@chromium.org | 83e1682 | 2011-09-13 08:21:47 +0000 | [diff] [blame] | 1 | // Copyright 2011 the V8 project authors. All rights reserved. |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 2 | // Redistribution and use in source and binary forms, with or without |
| 3 | // modification, are permitted provided that the following conditions are |
| 4 | // met: |
| 5 | // |
| 6 | // * Redistributions of source code must retain the above copyright |
| 7 | // notice, this list of conditions and the following disclaimer. |
| 8 | // * Redistributions in binary form must reproduce the above |
| 9 | // copyright notice, this list of conditions and the following |
| 10 | // disclaimer in the documentation and/or other materials provided |
| 11 | // with the distribution. |
| 12 | // * Neither the name of Google Inc. nor the names of its |
| 13 | // contributors may be used to endorse or promote products derived |
| 14 | // from this software without specific prior written permission. |
| 15 | // |
| 16 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 17 | // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 18 | // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 19 | // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 20 | // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 21 | // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 22 | // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 23 | // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 24 | // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 25 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 26 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 27 | |
yangguo@chromium.org | 304cc33 | 2012-07-24 07:59:48 +0000 | [diff] [blame] | 28 | #ifndef V8_SMART_POINTERS_H_ |
| 29 | #define V8_SMART_POINTERS_H_ |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 30 | |
kasperl@chromium.org | 71affb5 | 2009-05-26 05:44:31 +0000 | [diff] [blame] | 31 | namespace v8 { |
| 32 | namespace internal { |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 33 | |
| 34 | |
yangguo@chromium.org | 304cc33 | 2012-07-24 07:59:48 +0000 | [diff] [blame] | 35 | template<typename Deallocator, typename T> |
| 36 | class SmartPointerBase { |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 37 | public: |
ricow@chromium.org | 55ee807 | 2011-09-08 16:33:10 +0000 | [diff] [blame] | 38 | // Default constructor. Constructs an empty scoped pointer. |
yangguo@chromium.org | 304cc33 | 2012-07-24 07:59:48 +0000 | [diff] [blame] | 39 | inline SmartPointerBase() : p_(NULL) {} |
kasperl@chromium.org | b912362 | 2008-09-17 14:05:56 +0000 | [diff] [blame] | 40 | |
ricow@chromium.org | 55ee807 | 2011-09-08 16:33:10 +0000 | [diff] [blame] | 41 | // Constructs a scoped pointer from a plain one. |
yangguo@chromium.org | 304cc33 | 2012-07-24 07:59:48 +0000 | [diff] [blame] | 42 | explicit inline SmartPointerBase(T* ptr) : p_(ptr) {} |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 43 | |
| 44 | // Copy constructor removes the pointer from the original to avoid double |
| 45 | // freeing. |
yangguo@chromium.org | 304cc33 | 2012-07-24 07:59:48 +0000 | [diff] [blame] | 46 | inline SmartPointerBase(const SmartPointerBase<Deallocator, T>& rhs) |
| 47 | : p_(rhs.p_) { |
| 48 | const_cast<SmartPointerBase<Deallocator, T>&>(rhs).p_ = NULL; |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 49 | } |
| 50 | |
kasperl@chromium.org | b912362 | 2008-09-17 14:05:56 +0000 | [diff] [blame] | 51 | // When the destructor of the scoped pointer is executed the plain pointer |
| 52 | // is deleted using DeleteArray. This implies that you must allocate with |
| 53 | // NewArray. |
yangguo@chromium.org | 304cc33 | 2012-07-24 07:59:48 +0000 | [diff] [blame] | 54 | inline ~SmartPointerBase() { if (p_) Deallocator::Delete(p_); } |
kasperl@chromium.org | b912362 | 2008-09-17 14:05:56 +0000 | [diff] [blame] | 55 | |
ricow@chromium.org | 55ee807 | 2011-09-08 16:33:10 +0000 | [diff] [blame] | 56 | inline T* operator->() const { return p_; } |
kasperl@chromium.org | b912362 | 2008-09-17 14:05:56 +0000 | [diff] [blame] | 57 | |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 58 | // You can get the underlying pointer out with the * operator. |
ricow@chromium.org | 55ee807 | 2011-09-08 16:33:10 +0000 | [diff] [blame] | 59 | inline T* operator*() { return p_; } |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 60 | |
yangguo@chromium.org | a6bbcc8 | 2012-12-21 12:35:02 +0000 | [diff] [blame] | 61 | // You can use [n] to index as if it was a plain pointer. |
kasperl@chromium.org | b912362 | 2008-09-17 14:05:56 +0000 | [diff] [blame] | 62 | inline T& operator[](size_t i) { |
ricow@chromium.org | 55ee807 | 2011-09-08 16:33:10 +0000 | [diff] [blame] | 63 | return p_[i]; |
kasperl@chromium.org | b912362 | 2008-09-17 14:05:56 +0000 | [diff] [blame] | 64 | } |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 65 | |
yangguo@chromium.org | a6bbcc8 | 2012-12-21 12:35:02 +0000 | [diff] [blame] | 66 | // You can use [n] to index as if it was a plain pointer. |
| 67 | const inline T& operator[](size_t i) const { |
| 68 | return p_[i]; |
| 69 | } |
| 70 | |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 71 | // We don't have implicit conversion to a T* since that hinders migration: |
| 72 | // You would not be able to change a method from returning a T* to |
kmillikin@chromium.org | 83e1682 | 2011-09-13 08:21:47 +0000 | [diff] [blame] | 73 | // returning an SmartArrayPointer<T> and then get errors wherever it is used. |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 74 | |
| 75 | |
| 76 | // If you want to take out the plain pointer and don't want it automatically |
| 77 | // deleted then call Detach(). Afterwards, the smart pointer is empty |
| 78 | // (NULL). |
| 79 | inline T* Detach() { |
ricow@chromium.org | 55ee807 | 2011-09-08 16:33:10 +0000 | [diff] [blame] | 80 | T* temp = p_; |
| 81 | p_ = NULL; |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 82 | return temp; |
| 83 | } |
| 84 | |
yangguo@chromium.org | a6bbcc8 | 2012-12-21 12:35:02 +0000 | [diff] [blame] | 85 | inline void Reset(T* new_value) { |
| 86 | if (p_) Deallocator::Delete(p_); |
| 87 | p_ = new_value; |
| 88 | } |
| 89 | |
kmillikin@chromium.org | 83e1682 | 2011-09-13 08:21:47 +0000 | [diff] [blame] | 90 | // Assignment requires an empty (NULL) SmartArrayPointer as the receiver. Like |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 91 | // the copy constructor it removes the pointer in the original to avoid |
| 92 | // double freeing. |
yangguo@chromium.org | 304cc33 | 2012-07-24 07:59:48 +0000 | [diff] [blame] | 93 | inline SmartPointerBase<Deallocator, T>& operator=( |
| 94 | const SmartPointerBase<Deallocator, T>& rhs) { |
kasperl@chromium.org | 5a8ca6c | 2008-10-23 13:57:19 +0000 | [diff] [blame] | 95 | ASSERT(is_empty()); |
ricow@chromium.org | 55ee807 | 2011-09-08 16:33:10 +0000 | [diff] [blame] | 96 | T* tmp = rhs.p_; // swap to handle self-assignment |
yangguo@chromium.org | 304cc33 | 2012-07-24 07:59:48 +0000 | [diff] [blame] | 97 | const_cast<SmartPointerBase<Deallocator, T>&>(rhs).p_ = NULL; |
ricow@chromium.org | 55ee807 | 2011-09-08 16:33:10 +0000 | [diff] [blame] | 98 | p_ = tmp; |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 99 | return *this; |
| 100 | } |
| 101 | |
ricow@chromium.org | 55ee807 | 2011-09-08 16:33:10 +0000 | [diff] [blame] | 102 | inline bool is_empty() { return p_ == NULL; } |
kasperl@chromium.org | 5a8ca6c | 2008-10-23 13:57:19 +0000 | [diff] [blame] | 103 | |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 104 | private: |
ricow@chromium.org | 55ee807 | 2011-09-08 16:33:10 +0000 | [diff] [blame] | 105 | T* p_; |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 106 | }; |
| 107 | |
yangguo@chromium.org | 304cc33 | 2012-07-24 07:59:48 +0000 | [diff] [blame] | 108 | // A 'scoped array pointer' that calls DeleteArray on its pointer when the |
| 109 | // destructor is called. |
| 110 | |
| 111 | template<typename T> |
| 112 | struct ArrayDeallocator { |
| 113 | static void Delete(T* array) { |
| 114 | DeleteArray(array); |
| 115 | } |
| 116 | }; |
| 117 | |
| 118 | |
| 119 | template<typename T> |
| 120 | class SmartArrayPointer: public SmartPointerBase<ArrayDeallocator<T>, T> { |
| 121 | public: |
| 122 | inline SmartArrayPointer() { } |
| 123 | explicit inline SmartArrayPointer(T* ptr) |
| 124 | : SmartPointerBase<ArrayDeallocator<T>, T>(ptr) { } |
| 125 | inline SmartArrayPointer(const SmartArrayPointer<T>& rhs) |
| 126 | : SmartPointerBase<ArrayDeallocator<T>, T>(rhs) { } |
| 127 | }; |
| 128 | |
| 129 | |
| 130 | template<typename T> |
| 131 | struct ObjectDeallocator { |
| 132 | static void Delete(T* array) { |
| 133 | Malloced::Delete(array); |
| 134 | } |
| 135 | }; |
| 136 | |
| 137 | template<typename T> |
| 138 | class SmartPointer: public SmartPointerBase<ObjectDeallocator<T>, T> { |
| 139 | public: |
| 140 | inline SmartPointer() { } |
| 141 | explicit inline SmartPointer(T* ptr) |
| 142 | : SmartPointerBase<ObjectDeallocator<T>, T>(ptr) { } |
| 143 | inline SmartPointer(const SmartPointer<T>& rhs) |
| 144 | : SmartPointerBase<ObjectDeallocator<T>, T>(rhs) { } |
| 145 | }; |
| 146 | |
christian.plesner.hansen | 43d26ec | 2008-07-03 15:10:15 +0000 | [diff] [blame] | 147 | } } // namespace v8::internal |
| 148 | |
yangguo@chromium.org | 304cc33 | 2012-07-24 07:59:48 +0000 | [diff] [blame] | 149 | #endif // V8_SMART_POINTERS_H_ |