Unreviewed, rolling out r95699.
[WebKit-https.git] / Source / WebCore / platform / CrossThreadCopier.h
1 /*
2  * Copyright (C) 2009, 2010 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef CrossThreadCopier_h
32 #define CrossThreadCopier_h
33
34 #include <wtf/Assertions.h>
35 #include <wtf/Forward.h>
36 #include <wtf/PassOwnPtr.h>
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/RefPtr.h>
39 #include <wtf/Threading.h>
40 #include <wtf/TypeTraits.h>
41
42 namespace WebCore {
43
44     class KURL;
45     class ResourceError;
46     class ResourceRequest;
47     class ResourceResponse;
48     struct CrossThreadResourceResponseData;
49     struct CrossThreadResourceRequestData;
50     struct ThreadableLoaderOptions;
51
52     template<typename T> struct CrossThreadCopierPassThrough {
53         typedef T Type;
54         static Type copy(const T& parameter)
55         {
56             return parameter;
57         }
58     };
59
60     template<bool isConvertibleToInteger, bool isThreadSafeRefCounted, typename T> struct CrossThreadCopierBase;
61
62     // Integers get passed through without any changes.
63     template<typename T> struct CrossThreadCopierBase<true, false, T> : public CrossThreadCopierPassThrough<T> {
64     };
65
66     template<> struct CrossThreadCopierBase<false, false, ThreadableLoaderOptions> : public CrossThreadCopierPassThrough<ThreadableLoaderOptions> {
67     };
68
69     // Custom copy methods.
70     template<typename T> struct CrossThreadCopierBase<false, true, T> {
71         typedef typename WTF::RemoveTemplate<T, RefPtr>::Type TypeWithoutRefPtr;
72         typedef typename WTF::RemoveTemplate<TypeWithoutRefPtr, PassRefPtr>::Type TypeWithoutPassRefPtr;
73         typedef typename WTF::RemovePointer<TypeWithoutPassRefPtr>::Type RefCountedType;
74
75         // Verify that only one of the above did a change.
76         COMPILE_ASSERT((WTF::IsSameType<RefPtr<RefCountedType>, T>::value
77                         || WTF::IsSameType<PassRefPtr<RefCountedType>, T>::value
78                         || WTF::IsSameType<RefCountedType*, T>::value),
79                        OnlyAllowOneTypeModification);
80
81         typedef PassRefPtr<RefCountedType> Type;
82         static Type copy(const T& refPtr)
83         {
84             return refPtr;
85         }
86     };
87
88     template<typename T> struct CrossThreadCopierBase<false, false, PassOwnPtr<T> > {
89         typedef PassOwnPtr<T> Type;
90         static Type copy(Type ownPtr)
91         {
92             return ownPtr;
93         }
94     };
95
96     template<> struct CrossThreadCopierBase<false, false, KURL> {
97         typedef KURL Type;
98         static Type copy(const KURL&);
99     };
100
101     template<> struct CrossThreadCopierBase<false, false, String> {
102         typedef String Type;
103         static Type copy(const String&);
104     };
105
106     template<> struct CrossThreadCopierBase<false, false, ResourceError> {
107         typedef ResourceError Type;
108         static Type copy(const ResourceError&);
109     };
110
111     template<> struct CrossThreadCopierBase<false, false, ResourceRequest> {
112         typedef PassOwnPtr<CrossThreadResourceRequestData> Type;
113         static Type copy(const ResourceRequest&);
114     };
115
116     template<> struct CrossThreadCopierBase<false, false, ResourceResponse> {
117         typedef PassOwnPtr<CrossThreadResourceResponseData> Type;
118         static Type copy(const ResourceResponse&);
119     };
120
121     template<typename T> struct CrossThreadCopier : public CrossThreadCopierBase<WTF::IsConvertibleToInteger<T>::value,
122                                                                                  WTF::IsSubclassOfTemplate<typename WTF::RemoveTemplate<T, RefPtr>::Type, ThreadSafeRefCounted>::value
123                                                                                      || WTF::IsSubclassOfTemplate<typename WTF::RemovePointer<T>::Type, ThreadSafeRefCounted>::value
124                                                                                      || WTF::IsSubclassOfTemplate<typename WTF::RemoveTemplate<T, PassRefPtr>::Type, ThreadSafeRefCounted>::value,
125                                                                                  T> {
126     };
127
128     template<typename T> struct AllowCrossThreadAccessWrapper {
129     public:
130         explicit AllowCrossThreadAccessWrapper(T* value) : m_value(value) { }
131         T* value() const { return m_value; }
132     private:
133         T* m_value;
134     };
135
136     template<typename T> struct CrossThreadCopierBase<false, false, AllowCrossThreadAccessWrapper<T> > {
137         typedef T* Type;
138         static Type copy(const AllowCrossThreadAccessWrapper<T>& wrapper) { return wrapper.value(); }
139     };
140
141     template<typename T> AllowCrossThreadAccessWrapper<T> AllowCrossThreadAccess(T* value) 
142     {
143         return AllowCrossThreadAccessWrapper<T>(value);
144     }
145
146     // FIXME: Move to a different header file. AllowAccessLater is for cross-thread access
147     // that is not cross-thread (tasks posted to a queue guaranteed to run on the same thread).
148     template<typename T> struct AllowAccessLaterWrapper {
149     public:
150         explicit AllowAccessLaterWrapper(T* value) : m_value(value) { }
151         T* value() const { return m_value; }
152     private:
153         T* m_value;
154     };
155
156     template<typename T> struct CrossThreadCopierBase<false, false, AllowAccessLaterWrapper<T> > {
157         typedef T* Type;
158         static Type copy(const AllowAccessLaterWrapper<T>& wrapper) { return wrapper.value(); }
159     };
160
161     template<typename T> AllowAccessLaterWrapper<T> AllowAccessLater(T* value)
162     {
163         return AllowAccessLaterWrapper<T>(value);
164     }
165
166
167 } // namespace WebCore
168
169 #endif // CrossThreadCopier_h