initial import
[vuplus_webkit] / Source / JavaScriptCore / 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 "Assertions.h"
30 #include "NullPtr.h"
31 #include "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 #if COMPILER(WINSCW)
66     operator bool() const { return m_ptr; }
67 #else
68     typedef PtrType PassOwnArrayPtr::*UnspecifiedBoolType;
69     operator UnspecifiedBoolType() const { return m_ptr ? &PassOwnArrayPtr::m_ptr : 0; }
70 #endif
71
72     PassOwnArrayPtr& operator=(const PassOwnArrayPtr&) { COMPILE_ASSERT(!sizeof(T*), PassOwnArrayPtr_should_never_be_assigned_to); return *this; }
73
74     template<typename U> friend PassOwnArrayPtr<U> adoptArrayPtr(U*);
75
76 private:
77     explicit PassOwnArrayPtr(PtrType ptr) : m_ptr(ptr) { }
78
79     mutable PtrType m_ptr;
80 };
81
82 template<typename T> inline typename PassOwnArrayPtr<T>::PtrType PassOwnArrayPtr<T>::leakPtr() const
83 {
84     PtrType ptr = m_ptr;
85     m_ptr = 0;
86     return ptr;
87 }
88
89 template<typename T, typename U> inline bool operator==(const PassOwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b) 
90 {
91     return a.get() == b.get(); 
92 }
93
94 template<typename T, typename U> inline bool operator==(const PassOwnArrayPtr<T>& a, const OwnArrayPtr<U>& b) 
95 {
96     return a.get() == b.get(); 
97 }
98
99 template<typename T, typename U> inline bool operator==(const OwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b) 
100 {
101     return a.get() == b.get(); 
102 }
103
104 template<typename T, typename U> inline bool operator==(const PassOwnArrayPtr<T>& a, U* b) 
105 {
106     return a.get() == b; 
107 }
108
109 template<typename T, typename U> inline bool operator==(T* a, const PassOwnArrayPtr<U>& b) 
110 {
111     return a == b.get(); 
112 }
113
114 template<typename T, typename U> inline bool operator!=(const PassOwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b) 
115 {
116     return a.get() != b.get(); 
117 }
118
119 template<typename T, typename U> inline bool operator!=(const PassOwnArrayPtr<T>& a, const OwnArrayPtr<U>& b) 
120 {
121     return a.get() != b.get(); 
122 }
123
124 template<typename T, typename U> inline bool operator!=(const OwnArrayPtr<T>& a, const PassOwnArrayPtr<U>& b) 
125 {
126     return a.get() != b.get(); 
127 }
128
129 template<typename T, typename U> inline bool operator!=(const PassOwnArrayPtr<T>& a, U* b)
130 {
131     return a.get() != b; 
132 }
133
134 template<typename T, typename U> inline bool operator!=(T* a, const PassOwnArrayPtr<U>& b) 
135 {
136     return a != b.get(); 
137 }
138
139 template<typename T> inline PassOwnArrayPtr<T> adoptArrayPtr(T* ptr)
140 {
141     return PassOwnArrayPtr<T>(ptr);
142 }
143
144 template<typename T> inline void deleteOwnedArrayPtr(T* ptr)
145 {
146     typedef char known[sizeof(T) ? 1 : -1];
147     if (sizeof(known))
148         delete [] ptr;
149 }
150
151 template<typename T, typename U> inline PassOwnArrayPtr<T> static_pointer_cast(const PassOwnArrayPtr<U>& p) 
152 {
153     return adoptArrayPtr(static_cast<T*>(p.leakPtr()));
154 }
155
156 template<typename T, typename U> inline PassOwnArrayPtr<T> const_pointer_cast(const PassOwnArrayPtr<U>& p) 
157 {
158     return adoptArrayPtr(const_cast<T*>(p.leakPtr()));
159 }
160
161 template<typename T> inline T* getPtr(const PassOwnArrayPtr<T>& p)
162 {
163     return p.get();
164 }
165
166 } // namespace WTF
167
168 using WTF::PassOwnArrayPtr;
169 using WTF::adoptArrayPtr;
170 using WTF::const_pointer_cast;
171 using WTF::static_pointer_cast;
172
173 #endif // WTF_PassOwnArrayPtr_h