Source/WTF/wtf/PassOwnArrayPtr.h

   1 /*
   2  * Copyright (C) 2010 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef WTF_PassOwnArrayPtr_h
  27 #define WTF_PassOwnArrayPtr_h
  28
  29 #include <wtf/Assertions.h>
  30 #include <wtf/NullPtr.h>
  31 #include <wtf/TypeTraits.h>
  32
  33 namespace WTF {
  34
  35 template<typename T> class OwnArrayPtr;
  36 template<typename T> class PassOwnArrayPtr;
  37 template<typename T> PassOwnArrayPtr<T> adoptArrayPtr(T*);
  38 template<typename T> void deleteOwnedArrayPtr(T* ptr);
  39
  40 template<typename T> class PassOwnArrayPtr {
  41 public:
  42     typedef T* PtrType;
  43
  44     PassOwnArrayPtr() : m_ptr(0) { }
  45     PassOwnArrayPtr(std::nullptr_t) : m_ptr(0) { }
  46
  47     // It somewhat breaks the type system to allow transfer of ownership out of
  48     // a const PassOwnArrayPtr. However, it makes it much easier to work with PassOwnArrayPtr
  49     // temporaries, and we don't have a need to use real const PassOwnArrayPtrs anyway.
  50     PassOwnArrayPtr(const PassOwnArrayPtr& o) : m_ptr(o.leakPtr()) { }
  51     template<typename U> PassOwnArrayPtr(const PassOwnArrayPtr<U>& o) : m_ptr(o.leakPtr()) { }
  52
  53     ~PassOwnArrayPtr() { deleteOwnedArrayPtr(m_ptr); }
  54
  55     PtrType get() const { return m_ptr; }
  56
  57     PtrType leakPtr() const WARN_UNUSED_RETURN;
  58
  59     T& operator*() const { ASSERT(m_ptr); return *m_ptr; }
  60     PtrType operator->() const { ASSERT(m_ptr); return m_ptr; }
  61
  62     bool operator!() const { return !m_ptr; }
  63
  64     // This conversion operator allows implicit conversion to bool but not to other integer types.
  65     typedef PtrType PassOwnArrayPtr::*UnspecifiedBoolType;
  66     operator UnspecifiedBoolType() const { return m_ptr ? &PassOwnArrayPtr::m_ptr : 0; }
  67
  68     PassOwnArrayPtr& operator=(const PassOwnArrayPtr&) { COMPILE_ASSERT(!sizeof(T*), PassOwnArrayPtr_should_never_be_assigned_to); return *this; }
  69
  70     template<typename U> friend PassOwnArrayPtr<U> adoptArrayPtr(U*);
  71
  72 private:
  73     explicit PassOwnArrayPtr(PtrType ptr) : m_ptr(ptr) { }
  74
  75     mutable PtrType m_ptr;
  76 };
  77
  78 template<typename T> inline typename PassOwnArrayPtr<T>::PtrType PassOwnArrayPtr<T>::leakPtr() const
  79 {
  80     PtrType ptr = m_ptr;
  81     m_ptr = 0;
  82     return ptr;
  83 }
  84
  85 template<typename T, typename U> inline bool operator==(const PassOwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b)
  86 {
  87     return a.get() == b.get();
  88 }
  89
  90 template<typename T, typename U> inline bool operator==(const PassOwnArrayPtr<T>& a, const OwnArrayPtr<U>& b)
  91 {
  92     return a.get() == b.get();
  93 }
  94
  95 template<typename T, typename U> inline bool operator==(const OwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b)
  96 {
  97     return a.get() == b.get();
  98 }
  99
 100 template<typename T, typename U> inline bool operator==(const PassOwnArrayPtr<T>& a, U* b)
 101 {
 102     return a.get() == b;
 103 }
 104
 105 template<typename T, typename U> inline bool operator==(T* a, const PassOwnArrayPtr<U>& b)
 106 {
 107     return a == b.get();
 108 }
 109
 110 template<typename T, typename U> inline bool operator!=(const PassOwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b)
 111 {
 112     return a.get() != b.get();
 113 }
 114
 115 template<typename T, typename U> inline bool operator!=(const PassOwnArrayPtr<T>& a, const OwnArrayPtr<U>& b)
 116 {
 117     return a.get() != b.get();
 118 }
 119
 120 template<typename T, typename U> inline bool operator!=(const OwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b)
 121 {
 122     return a.get() != b.get();
 123 }
 124
 125 template<typename T, typename U> inline bool operator!=(const PassOwnArrayPtr<T>& a, U* b)
 126 {
 127     return a.get() != b;
 128 }
 129
 130 template<typename T, typename U> inline bool operator!=(T* a, const PassOwnArrayPtr<U>& b)
 131 {
 132     return a != b.get();
 133 }
 134
 135 template<typename T> inline PassOwnArrayPtr<T> adoptArrayPtr(T* ptr)
 136 {
 137     return PassOwnArrayPtr<T>(ptr);
 138 }
 139
 140 template<typename T> inline void deleteOwnedArrayPtr(T* ptr)
 141 {
 142     typedef char known[sizeof(T) ? 1 : -1];
 143     if (sizeof(known))
 144         delete [] ptr;
 145 }
 146
 147 template<typename T, typename U> inline PassOwnArrayPtr<T> static_pointer_cast(const PassOwnArrayPtr<U>& p)
 148 {
 149     return adoptArrayPtr(static_cast<T*>(p.leakPtr()));
 150 }
 151
 152 template<typename T, typename U> inline PassOwnArrayPtr<T> const_pointer_cast(const PassOwnArrayPtr<U>& p)
 153 {
 154     return adoptArrayPtr(const_cast<T*>(p.leakPtr()));
 155 }
 156
 157 template<typename T> inline T* getPtr(const PassOwnArrayPtr<T>& p)
 158 {
 159     return p.get();
 160 }
 161
 162 } // namespace WTF
 163
 164 using WTF::PassOwnArrayPtr;
 165 using WTF::adoptArrayPtr;
 166 using WTF::const_pointer_cast;
 167 using WTF::static_pointer_cast;
 168
 169 #endif // WTF_PassOwnArrayPtr_h