[Chromium] Enable AtomicString && CString && WTFString && StringImpl unit tests
[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/Assertions.h>
26 #include <wtf/NullPtr.h>
27
28 namespace WTF {
29
30     template<typename T> class RefPtr;
31     template<typename T> class PassRefPtr;
32     template<typename T> PassRefPtr<T> adoptRef(T*);
33
34     inline void adopted(const void*) { }
35
36 #if !(PLATFORM(QT) && CPU(ARM))
37     #define REF_DEREF_INLINE ALWAYS_INLINE
38 #else
39     // Older version of gcc used by Harmattan SDK fails to build with ALWAYS_INLINE.
40     // See https://bugs.webkit.org/show_bug.cgi?id=37253 for details.
41     #define REF_DEREF_INLINE inline
42 #endif
43
44     template<typename T> REF_DEREF_INLINE void refIfNotNull(T* ptr)
45     {
46         if (LIKELY(ptr != 0))
47             ptr->ref();
48     }
49
50     template<typename T> REF_DEREF_INLINE void derefIfNotNull(T* ptr)
51     {
52         if (LIKELY(ptr != 0))
53             ptr->deref();
54     }
55
56     #undef REF_DEREF_INLINE
57
58     template<typename T> class PassRefPtr {
59     public:
60         PassRefPtr() : m_ptr(0) { }
61         PassRefPtr(T* ptr) : m_ptr(ptr) { refIfNotNull(ptr); }
62         // It somewhat breaks the type system to allow transfer of ownership out of
63         // a const PassRefPtr. However, it makes it much easier to work with PassRefPtr
64         // temporaries, and we don't have a need to use real const PassRefPtrs anyway.
65         PassRefPtr(const PassRefPtr& o) : m_ptr(o.leakRef()) { }
66         template<typename U> PassRefPtr(const PassRefPtr<U>& o) : m_ptr(o.leakRef()) { }
67
68         ALWAYS_INLINE ~PassRefPtr() { derefIfNotNull(m_ptr); }
69
70         template<typename U> PassRefPtr(const RefPtr<U>&);
71         
72         T* get() const { return m_ptr; }
73
74         T* leakRef() const WARN_UNUSED_RETURN;
75
76         T& operator*() const { return *m_ptr; }
77         T* operator->() const { return m_ptr; }
78
79         bool operator!() const { return !m_ptr; }
80
81         // This conversion operator allows implicit conversion to bool but not to other integer types.
82         typedef T* (PassRefPtr::*UnspecifiedBoolType);
83         operator UnspecifiedBoolType() const { return m_ptr ? &PassRefPtr::m_ptr : 0; }
84
85         PassRefPtr& operator=(const PassRefPtr&) { COMPILE_ASSERT(!sizeof(T*), PassRefPtr_should_never_be_assigned_to); return *this; }
86
87         friend PassRefPtr adoptRef<T>(T*);
88
89     private:
90         // adopting constructor
91         PassRefPtr(T* ptr, bool) : m_ptr(ptr) { }
92
93         mutable T* m_ptr;
94     };
95     
96     template<typename T> template<typename U> inline PassRefPtr<T>::PassRefPtr(const RefPtr<U>& o)
97         : m_ptr(o.get())
98     {
99         T* ptr = m_ptr;
100         refIfNotNull(ptr);
101     }
102
103     template<typename T> inline T* PassRefPtr<T>::leakRef() const
104     {
105         T* ptr = m_ptr;
106         m_ptr = 0;
107         return ptr;
108     }
109
110     template<typename T, typename U> inline bool operator==(const PassRefPtr<T>& a, const PassRefPtr<U>& b) 
111     { 
112         return a.get() == b.get(); 
113     }
114
115     template<typename T, typename U> inline bool operator==(const PassRefPtr<T>& a, const RefPtr<U>& b) 
116     { 
117         return a.get() == b.get(); 
118     }
119
120     template<typename T, typename U> inline bool operator==(const RefPtr<T>& a, const PassRefPtr<U>& b) 
121     { 
122         return a.get() == b.get(); 
123     }
124
125     template<typename T, typename U> inline bool operator==(const PassRefPtr<T>& a, U* b) 
126     { 
127         return a.get() == b; 
128     }
129     
130     template<typename T, typename U> inline bool operator==(T* a, const PassRefPtr<U>& b) 
131     {
132         return a == b.get(); 
133     }
134     
135     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, const PassRefPtr<U>& b) 
136     { 
137         return a.get() != b.get(); 
138     }
139
140     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, const RefPtr<U>& b) 
141     { 
142         return a.get() != b.get(); 
143     }
144
145     template<typename T, typename U> inline bool operator!=(const RefPtr<T>& a, const PassRefPtr<U>& b) 
146     { 
147         return a.get() != b.get(); 
148     }
149
150     template<typename T, typename U> inline bool operator!=(const PassRefPtr<T>& a, U* b)
151     {
152         return a.get() != b; 
153     }
154
155     template<typename T, typename U> inline bool operator!=(T* a, const PassRefPtr<U>& b) 
156     { 
157         return a != b.get(); 
158     }
159     
160     template<typename T> inline PassRefPtr<T> adoptRef(T* p)
161     {
162         adopted(p);
163         return PassRefPtr<T>(p, true);
164     }
165
166     template<typename T, typename U> inline PassRefPtr<T> static_pointer_cast(const PassRefPtr<U>& p) 
167     { 
168         return adoptRef(static_cast<T*>(p.leakRef())); 
169     }
170
171     template<typename T, typename U> inline PassRefPtr<T> const_pointer_cast(const PassRefPtr<U>& p) 
172     { 
173         return adoptRef(const_cast<T*>(p.leakRef())); 
174     }
175
176     template<typename T> inline T* getPtr(const PassRefPtr<T>& p)
177     {
178         return p.get();
179     }
180
181 } // namespace WTF
182
183 using WTF::PassRefPtr;
184 using WTF::adoptRef;
185 using WTF::static_pointer_cast;
186 using WTF::const_pointer_cast;
187
188 #endif // WTF_PassRefPtr_h