[Qt]r57240 broke Qt build (gcc bug)
[WebKit-https.git] / Source / WTF / wtf / PassRefPtr.h
1 /*
2  *  Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
3  *
4  *  This library is free software; you can redistribute it and/or
5  *  modify it under the terms of the GNU Library General Public
6  *  License as published by the Free Software Foundation; either
7  *  version 2 of the License, or (at your option) any later version.
8  *
9  *  This library is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  *  Library General Public License for more details.
13  *
14  *  You should have received a copy of the GNU Library General Public License
15  *  along with this library; see the file COPYING.LIB.  If not, write to
16  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  *  Boston, MA 02110-1301, USA.
18  *
19  */
20
21 #ifndef WTF_PassRefPtr_h
22 #define WTF_PassRefPtr_h
23
24 #include <wtf/AlwaysInline.h>
25 #include <wtf/NullPtr.h>
26
27 namespace WTF {
28
29     template<typename T> class RefPtr;
30     template<typename T> class PassRefPtr;
31     template<typename T> PassRefPtr<T> adoptRef(T*);
32
33     inline void adopted(const void*) { }
34
35     #define REF_DEREF_INLINE ALWAYS_INLINE
36
37     template<typename T> REF_DEREF_INLINE void refIfNotNull(T* ptr)
38     {
39         if (LIKELY(ptr != 0))
40             ptr->ref();
41     }
42
43     template<typename T> REF_DEREF_INLINE void derefIfNotNull(T* ptr)
44     {
45         if (LIKELY(ptr != 0))
46             ptr->deref();
47     }
48
49     #undef REF_DEREF_INLINE
50
51     template<typename T> class PassRefPtr {
52     public:
53         PassRefPtr() : m_ptr(0) { }
54         PassRefPtr(T* ptr) : m_ptr(ptr) { refIfNotNull(ptr); }
55         // It somewhat breaks the type system to allow transfer of ownership out of
56         // a const PassRefPtr. However, it makes it much easier to work with PassRefPtr
57         // temporaries, and we don't have a need to use real const PassRefPtrs anyway.
58         PassRefPtr(const PassRefPtr& o) : m_ptr(o.leakRef()) { }
59         template<typename U> PassRefPtr(const PassRefPtr<U>& o) : m_ptr(o.leakRef()) { }
60
61         ALWAYS_INLINE ~PassRefPtr() { derefIfNotNull(m_ptr); }
62
63         template<typename U> PassRefPtr(const RefPtr<U>&);
64         
65         T* get() const { return m_ptr; }
66
67         T* leakRef() const WARN_UNUSED_RETURN;
68
69         T& operator*() const { return *m_ptr; }
70         T* operator->() const { return m_ptr; }
71
72         bool operator!() const { return !m_ptr; }
73
74         // This conversion operator allows implicit conversion to bool but not to other integer types.
75         typedef T* (PassRefPtr::*UnspecifiedBoolType);
76         operator UnspecifiedBoolType() const { return m_ptr ? &PassRefPtr::m_ptr : 0; }
77
78         PassRefPtr& operator=(const PassRefPtr&) { COMPILE_ASSERT(!sizeof(T*), PassRefPtr_should_never_be_assigned_to); return *this; }
79
80         friend PassRefPtr adoptRef<T>(T*);
81
82     private:
83         // adopting constructor
84         PassRefPtr(T* ptr, bool) : m_ptr(ptr) { }
85
86         mutable T* m_ptr;
87     };
88     
89     template<typename T> template<typename U> inline PassRefPtr<T>::PassRefPtr(const RefPtr<U>& o)
90         : m_ptr(o.get())
91     {
92         T* ptr = m_ptr;
93         refIfNotNull(ptr);
94     }
95
96     template<typename T> inline T* PassRefPtr<T>::leakRef() const
97     {
98         T* ptr = m_ptr;
99         m_ptr = 0;
100         return ptr;
101     }
102
103     template<typename T, typename U> inline bool operator==(const PassRefPtr<T>& a, const PassRefPtr<U>& b) 
104     { 
105         return a.get() == b.get(); 
106     }
107
108     template<typename T, typename U> inline bool operator==(const PassRefPtr<T>& a, const RefPtr<U>& b) 
109     { 
110         return a.get() == b.get(); 
111     }
112
113     template<typename T, typename U> inline bool operator==(const RefPtr<T>& a, const PassRefPtr<U>& b) 
114     { 
115         return a.get() == b.get(); 
116     }
117
118     template<typename T, typename U> inline bool operator==(const PassRefPtr<T>& a, U* b) 
119     { 
120         return a.get() == b; 
121     }
122     
123     template<typename T, typename U> inline bool operator==(T* a, const PassRefPtr<U>& b) 
124     {
125         return a == b.get(); 
126     }
127     
128     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, const PassRefPtr<U>& b) 
129     { 
130         return a.get() != b.get(); 
131     }
132
133     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, const RefPtr<U>& b) 
134     { 
135         return a.get() != b.get(); 
136     }
137
138     template<typename T, typename U> inline bool operator!=(const RefPtr<T>& a, const PassRefPtr<U>& b) 
139     { 
140         return a.get() != b.get(); 
141     }
142
143     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, U* b)
144     {
145         return a.get() != b; 
146     }
147
148     template<typename T, typename U> inline bool operator!=(T* a, const PassRefPtr<U>& b) 
149     { 
150         return a != b.get(); 
151     }
152     
153     template<typename T> inline PassRefPtr<T> adoptRef(T* p)
154     {
155         adopted(p);
156         return PassRefPtr<T>(p, true);
157     }
158
159     template<typename T, typename U> inline PassRefPtr<T> static_pointer_cast(const PassRefPtr<U>& p) 
160     { 
161         return adoptRef(static_cast<T*>(p.leakRef())); 
162     }
163
164     template<typename T, typename U> inline PassRefPtr<T> const_pointer_cast(const PassRefPtr<U>& p) 
165     { 
166         return adoptRef(const_cast<T*>(p.leakRef())); 
167     }
168
169     template<typename T> inline T* getPtr(const PassRefPtr<T>& p)
170     {
171         return p.get();
172     }
173
174 } // namespace WTF
175
176 using WTF::PassRefPtr;
177 using WTF::adoptRef;
178 using WTF::static_pointer_cast;
179 using WTF::const_pointer_cast;
180
181 #endif // WTF_PassRefPtr_h