Unreviewed, rolling out r219361.
[WebKit-https.git] / Source / WebCore / bindings / IDLTypes.h
1 /*
2  * Copyright (C) 2016 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <heap/HandleTypes.h>
29 #include <wtf/Brigand.h>
30 #include <wtf/HashMap.h>
31 #include <wtf/StdLibExtras.h>
32 #include <wtf/text/WTFString.h>
33
34 #if ENABLE(WEBGL)
35 #include "WebGLAny.h"
36 #endif
37
38 namespace JSC {
39 class ArrayBuffer;
40 class ArrayBufferView;
41 class DataView;
42 class JSValue;
43 class JSObject;
44 template<typename> class Strong;
45 }
46
47 namespace WebCore {
48
49 class IDBKey;
50 class IDBKeyData;
51 class IDBValue;
52 class DOMPromise;
53
54 #if ENABLE(WEBGL)
55 class WebGLExtension;
56 #endif
57
58 template<typename T>
59 struct IDLType {
60     using ImplementationType = T;
61
62     using ParameterType = T;
63     using NullableParameterType = std::optional<ImplementationType>;
64
65     using NullableType = std::optional<ImplementationType>;
66     static NullableType nullValue() { return std::nullopt; }
67     static bool isNullValue(const NullableType& value) { return !value; }
68     static ImplementationType extractValueFromNullable(const NullableType& value) { return value.value(); }
69 };
70
71 // IDLUnsupportedType is a special type that serves as a base class for currently unsupported types.
72 struct IDLUnsupportedType : IDLType<void> { };
73
74 // IDLNull is a special type for use as a subtype in an IDLUnion that is nullable.
75 struct IDLNull : IDLType<std::nullptr_t> { };
76
77 struct IDLAny : IDLType<JSC::Strong<JSC::Unknown>> {
78     using ParameterType = JSC::JSValue;
79     using NullableParameterType = JSC::JSValue;
80
81     using NullableType = JSC::Strong<JSC::Unknown>;
82     static inline std::nullptr_t nullValue() { return nullptr; }
83     template<typename U> static inline bool isNullValue(U&& value) { return !value; }
84     template<typename U> static inline U&& extractValueFromNullable(U&& value) { return std::forward<U>(value); }
85 };
86
87 struct IDLVoid : IDLType<void> { };
88
89 struct IDLBoolean : IDLType<bool> { };
90
91 template<typename NumericType> struct IDLNumber : IDLType<NumericType> { };
92
93 template<typename IntegerType> struct IDLInteger : IDLNumber<IntegerType> { };
94 struct IDLByte : IDLInteger<int8_t> { };
95 struct IDLOctet : IDLInteger<uint8_t> { };
96 struct IDLShort : IDLInteger<int16_t> { };
97 struct IDLUnsignedShort : IDLInteger<uint16_t> { };
98 struct IDLLong : IDLInteger<int32_t> { };
99 struct IDLUnsignedLong : IDLInteger<uint32_t> { };
100 struct IDLLongLong : IDLInteger<int64_t> { };
101 struct IDLUnsignedLongLong : IDLInteger<uint64_t> { };
102
103 template<typename T> struct IDLClampAdaptor : IDLInteger<typename T::ImplementationType> {
104     using InnerType = T;
105 };
106
107 template<typename T> struct IDLEnforceRangeAdaptor : IDLInteger<typename T::ImplementationType> {
108     using InnerType = T;
109 };
110
111 template<typename FloatingPointType> struct IDLFloatingPoint : IDLNumber<FloatingPointType> { };
112 struct IDLFloat : IDLFloatingPoint<float> { };
113 struct IDLUnrestrictedFloat : IDLFloatingPoint<float> { };
114 struct IDLDouble : IDLFloatingPoint<double> { };
115 struct IDLUnrestrictedDouble : IDLFloatingPoint<double> { };
116
117 template<typename StringType> struct IDLString : IDLType<StringType> {
118     using ParameterType = const StringType&;
119     using NullableParameterType = const StringType&;
120
121     using NullableType = StringType;
122     static StringType nullValue() { return StringType(); }
123     static bool isNullValue(const StringType& value) { return value.isNull(); }
124     template <typename U> static U&& extractValueFromNullable(U&& value) { return std::forward<U>(value); }
125 };
126 struct IDLDOMString : IDLString<String> { };
127 struct IDLByteString : IDLString<String> { };
128 struct IDLUSVString : IDLString<String> { };
129
130 template<typename T> struct IDLTreatNullAsEmptyAdaptor : IDLString<String> {
131     using InnerType = T;
132 };
133
134 template<typename T> struct IDLAtomicStringAdaptor : IDLString<AtomicString> {
135     using InnerType = T;
136 };
137
138 template<typename T> struct IDLRequiresExistingAtomicStringAdaptor : IDLString<AtomicString> {
139     using InnerType = T;
140 };
141
142 struct IDLObject : IDLType<JSC::Strong<JSC::JSObject>> {
143     using NullableType = JSC::Strong<JSC::JSObject>;
144
145     static inline std::nullptr_t nullValue() { return nullptr; }
146     template<typename U> static inline bool isNullValue(U&& value) { return !value; }
147     template<typename U> static inline U&& extractValueFromNullable(U&& value) { return std::forward<U>(value); }
148 };
149
150 template<typename T> struct IDLWrapper : IDLType<RefPtr<T>> {
151     using RawType = T;
152
153     using ParameterType = T&;
154     using NullableParameterType = T*;
155
156     using NullableType = RefPtr<T>;
157     static inline std::nullptr_t nullValue() { return nullptr; }
158     template<typename U> static inline bool isNullValue(U&& value) { return !value; }
159     template<typename U> static inline U&& extractValueFromNullable(U&& value) { return std::forward<U>(value); }
160 };
161
162 template<typename T> struct IDLInterface : IDLWrapper<T> { };
163 template<typename T> struct IDLCallbackInterface : IDLWrapper<T> { };
164 template<typename T> struct IDLCallbackFunction : IDLWrapper<T> { };
165
166 template<typename T> struct IDLDictionary : IDLType<T> {
167     using ParameterType = const T&;
168     using NullableParameterType = const T&;
169 };
170
171 template<typename T> struct IDLEnumeration : IDLType<T> { };
172
173 template<typename T> struct IDLNullable : IDLType<typename T::NullableType> {
174     using InnerType = T;
175
176     using ParameterType = typename T::NullableParameterType;
177     using NullableParameterType = typename T::NullableParameterType;
178
179     using NullableType = typename T::NullableType;
180     static inline auto nullValue() -> decltype(T::nullValue()) { return T::nullValue(); }
181     template<typename U> static inline bool isNullValue(U&& value) { return T::isNullValue(std::forward<U>(value)); }
182     template<typename U> static inline auto extractValueFromNullable(U&& value) -> decltype(T::extractValueFromNullable(std::forward<U>(value))) { return T::extractValueFromNullable(std::forward<U>(value)); }
183 };
184
185 template<typename T> struct IDLSequence : IDLType<Vector<typename T::ImplementationType>> {
186     using InnerType = T;
187
188     using ParameterType = const Vector<typename T::ImplementationType>&;
189     using NullableParameterType = const std::optional<Vector<typename T::ImplementationType>>&;
190 };
191
192 template<typename T> struct IDLFrozenArray : IDLType<Vector<typename T::ImplementationType>> {
193     using InnerType = T;
194
195     using ParameterType = const Vector<typename T::ImplementationType>&;
196     using NullableParameterType = const std::optional<Vector<typename T::ImplementationType>>&;
197 };
198
199 template<typename K, typename V> struct IDLRecord : IDLType<Vector<WTF::KeyValuePair<typename K::ImplementationType, typename V::ImplementationType>>> {
200     using KeyType = K;
201     using ValueType = V;
202
203     using ParameterType = const Vector<WTF::KeyValuePair<typename K::ImplementationType, typename V::ImplementationType>>&;
204     using NullableParameterType = const std::optional<Vector<WTF::KeyValuePair<typename K::ImplementationType, typename V::ImplementationType>>>&;
205 };
206
207 template<typename T> struct IDLPromise : IDLType<DOMPromise> {
208     using InnerType = T;
209 };
210
211 struct IDLError : IDLUnsupportedType { };
212 struct IDLDOMException : IDLUnsupportedType { };
213
214 template<typename... Ts>
215 struct IDLUnion : IDLType<Variant<typename Ts::ImplementationType...>> {
216     using TypeList = brigand::list<Ts...>;
217
218     using ParameterType = const Variant<typename Ts::ImplementationType...>&;
219     using NullableParameterType = const std::optional<Variant<typename Ts::ImplementationType...>>&;
220 };
221
222 template<typename T> struct IDLBufferSource : IDLWrapper<T> { };
223
224 struct IDLArrayBuffer : IDLBufferSource<JSC::ArrayBuffer> { };
225 // NOTE: WebIDL defines ArrayBufferView as an IDL union of all the TypedArray types.
226 //       and DataView. For convience in our implementation, we give it a distinct
227 //       type that maps to the shared based class of all those classes.
228 struct IDLArrayBufferView : IDLBufferSource<JSC::ArrayBufferView> { };
229 struct IDLDataView : IDLBufferSource<JSC::DataView> { };
230
231 template<typename T> struct IDLTypedArray : IDLBufferSource<T> { };
232 // NOTE: The specific typed array types are IDLTypedArray specialized on the typed array
233 //       implementation type, e.g. IDLFloat64Array is IDLTypedArray<JSC::Float64Array>
234
235
236 // Non-WebIDL extensions
237
238 struct IDLDate : IDLType<double> { 
239     using NullableType = double;
240     static double nullValue() { return std::numeric_limits<double>::quiet_NaN(); }
241     static bool isNullValue(double value) { return std::isnan(value); }
242     static double extractValueFromNullable(double value) { return value; }
243 };
244
245 struct IDLJSON : IDLType<String> { 
246     using ParameterType = const String&;
247     using NullableParameterType = const String&;
248
249     using NullableType = String;
250     static String nullValue() { return String(); }
251     static bool isNullValue(const String& value) { return value.isNull(); }
252     template <typename U> static U&& extractValueFromNullable(U&& value) { return std::forward<U>(value); }
253 };
254
255 template<typename T> struct IDLSerializedScriptValue : IDLWrapper<T> { };
256 template<typename T> struct IDLEventListener : IDLWrapper<T> { };
257 template<typename T> struct IDLXPathNSResolver : IDLWrapper<T> { };
258
259 struct IDLIDBKey : IDLWrapper<IDBKey> { };
260 struct IDLIDBKeyData : IDLWrapper<IDBKeyData> { };
261 struct IDLIDBValue : IDLWrapper<IDBValue> { };
262
263 #if ENABLE(WEBGL)
264 struct IDLWebGLAny : IDLType<WebGLAny> { };
265 struct IDLWebGLExtension : IDLWrapper<WebGLExtension> { };
266 #endif
267
268 // Helper predicates
269
270 template<typename T>
271 struct IsIDLInterface : public std::integral_constant<bool, WTF::IsTemplate<T, IDLInterface>::value> { };
272
273 template<typename T>
274 struct IsIDLDictionary : public std::integral_constant<bool, WTF::IsTemplate<T, IDLDictionary>::value> { };
275
276 template<typename T>
277 struct IsIDLEnumeration : public std::integral_constant<bool, WTF::IsTemplate<T, IDLEnumeration>::value> { };
278
279 template<typename T>
280 struct IsIDLSequence : public std::integral_constant<bool, WTF::IsTemplate<T, IDLSequence>::value> { };
281
282 template<typename T>
283 struct IsIDLFrozenArray : public std::integral_constant<bool, WTF::IsTemplate<T, IDLFrozenArray>::value> { };
284
285 template<typename T>
286 struct IsIDLRecord : public std::integral_constant<bool, WTF::IsTemplate<T, IDLRecord>::value> { };
287
288 template<typename T>
289 struct IsIDLString : public std::integral_constant<bool, WTF::IsBaseOfTemplate<IDLString, T>::value> { };
290
291 template<typename T>
292 struct IsIDLStringOrEnumeration : public std::integral_constant<bool, WTF::IsBaseOfTemplate<IDLString, T>::value || WTF::IsTemplate<T, IDLEnumeration>::value> { };
293
294 template<typename T>
295 struct IsIDLNumber : public std::integral_constant<bool, WTF::IsBaseOfTemplate<IDLNumber, T>::value> { };
296
297 template<typename T>
298 struct IsIDLInteger : public std::integral_constant<bool, WTF::IsBaseOfTemplate<IDLInteger, T>::value> { };
299
300 template<typename T>
301 struct IsIDLFloatingPoint : public std::integral_constant<bool, WTF::IsBaseOfTemplate<IDLFloatingPoint, T>::value> { };
302
303 template<typename T>
304 struct IsIDLTypedArray : public std::integral_constant<bool, WTF::IsBaseOfTemplate<IDLTypedArray, T>::value> { };
305
306 } // namespace WebCore