Make variant only available when compiling for C++14 or greater
[WebKit-https.git] / Source / WTF / wtf / StdLibExtras.h
1 /*
2  * Copyright (C) 2008, 2016 Apple Inc. All Rights Reserved.
3  * Copyright (C) 2013 Patrick Gansterer <paroga@paroga.com>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef WTF_StdLibExtras_h
28 #define WTF_StdLibExtras_h
29
30 #include <chrono>
31 #include <memory>
32 #include <string.h>
33 #include <wtf/Assertions.h>
34 #include <wtf/CheckedArithmetic.h>
35 #include <wtf/Variant.h>
36
37 // This was used to declare and define a static local variable (static T;) so that
38 //  it was leaked so that its destructors were not called at exit.
39 // Newly written code should use static NeverDestroyed<T> instead.
40 #ifndef DEPRECATED_DEFINE_STATIC_LOCAL
41 #define DEPRECATED_DEFINE_STATIC_LOCAL(type, name, arguments) \
42     static type& name = *new type arguments
43 #endif
44
45 // Use this macro to declare and define a debug-only global variable that may have a
46 // non-trivial constructor and destructor. When building with clang, this will suppress
47 // warnings about global constructors and exit-time destructors.
48 #define DEFINE_GLOBAL_FOR_LOGGING(type, name, arguments) \
49     _Pragma("clang diagnostic push") \
50     _Pragma("clang diagnostic ignored \"-Wglobal-constructors\"") \
51     _Pragma("clang diagnostic ignored \"-Wexit-time-destructors\"") \
52     static type name arguments; \
53     _Pragma("clang diagnostic pop")
54
55 #ifndef NDEBUG
56 #if COMPILER(CLANG)
57 #define DEFINE_DEBUG_ONLY_GLOBAL(type, name, arguments) DEFINE_GLOBAL_FOR_LOGGING(type, name, arguments)
58 #else
59 #define DEFINE_DEBUG_ONLY_GLOBAL(type, name, arguments) \
60     static type name arguments;
61 #endif // COMPILER(CLANG)
62 #else
63 #define DEFINE_DEBUG_ONLY_GLOBAL(type, name, arguments)
64 #endif // NDEBUG
65
66 // OBJECT_OFFSETOF: Like the C++ offsetof macro, but you can use it with classes.
67 // The magic number 0x4000 is insignificant. We use it to avoid using NULL, since
68 // NULL can cause compiler problems, especially in cases of multiple inheritance.
69 #define OBJECT_OFFSETOF(class, field) (reinterpret_cast<ptrdiff_t>(&(reinterpret_cast<class*>(0x4000)->field)) - 0x4000)
70
71 // STRINGIZE: Can convert any value to quoted string, even expandable macros
72 #define STRINGIZE(exp) #exp
73 #define STRINGIZE_VALUE_OF(exp) STRINGIZE(exp)
74
75 // Make "PRId64" format specifier work for Visual C++ on Windows.
76 #if OS(WINDOWS) && !defined(PRId64)
77 #define PRId64 "lld"
78 #endif
79
80 /*
81  * The reinterpret_cast<Type1*>([pointer to Type2]) expressions - where
82  * sizeof(Type1) > sizeof(Type2) - cause the following warning on ARM with GCC:
83  * increases required alignment of target type.
84  *
85  * An implicit or an extra static_cast<void*> bypasses the warning.
86  * For more info see the following bugzilla entries:
87  * - https://bugs.webkit.org/show_bug.cgi?id=38045
88  * - http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43976
89  */
90 #if (CPU(ARM) || CPU(MIPS)) && COMPILER(GCC_OR_CLANG)
91 template<typename Type>
92 inline bool isPointerTypeAlignmentOkay(Type* ptr)
93 {
94     return !(reinterpret_cast<intptr_t>(ptr) % __alignof__(Type));
95 }
96
97 template<typename TypePtr>
98 inline TypePtr reinterpret_cast_ptr(void* ptr)
99 {
100     ASSERT(isPointerTypeAlignmentOkay(reinterpret_cast<TypePtr>(ptr)));
101     return reinterpret_cast<TypePtr>(ptr);
102 }
103
104 template<typename TypePtr>
105 inline TypePtr reinterpret_cast_ptr(const void* ptr)
106 {
107     ASSERT(isPointerTypeAlignmentOkay(reinterpret_cast<TypePtr>(ptr)));
108     return reinterpret_cast<TypePtr>(ptr);
109 }
110 #else
111 template<typename Type>
112 inline bool isPointerTypeAlignmentOkay(Type*)
113 {
114     return true;
115 }
116 #define reinterpret_cast_ptr reinterpret_cast
117 #endif
118
119 namespace WTF {
120
121 enum CheckMoveParameterTag { CheckMoveParameter };
122
123 static const size_t KB = 1024;
124 static const size_t MB = 1024 * 1024;
125 static const size_t GB = 1024 * 1024 * 1024;
126
127 inline bool isPointerAligned(void* p)
128 {
129     return !((intptr_t)(p) & (sizeof(char*) - 1));
130 }
131
132 inline bool is8ByteAligned(void* p)
133 {
134     return !((uintptr_t)(p) & (sizeof(double) - 1));
135 }
136
137 /*
138  * C++'s idea of a reinterpret_cast lacks sufficient cojones.
139  */
140 template<typename ToType, typename FromType>
141 inline ToType bitwise_cast(FromType from)
142 {
143     static_assert(sizeof(FromType) == sizeof(ToType), "bitwise_cast size of FromType and ToType must be equal!");
144     union {
145         FromType from;
146         ToType to;
147     } u;
148     u.from = from;
149     return u.to;
150 }
151
152 template<typename ToType, typename FromType>
153 inline ToType safeCast(FromType value)
154 {
155     ASSERT(isInBounds<ToType>(value));
156     return static_cast<ToType>(value);
157 }
158
159 // Returns a count of the number of bits set in 'bits'.
160 inline size_t bitCount(unsigned bits)
161 {
162     bits = bits - ((bits >> 1) & 0x55555555);
163     bits = (bits & 0x33333333) + ((bits >> 2) & 0x33333333);
164     return (((bits + (bits >> 4)) & 0xF0F0F0F) * 0x1010101) >> 24;
165 }
166
167 inline size_t bitCount(uint64_t bits)
168 {
169     return bitCount(static_cast<unsigned>(bits)) + bitCount(static_cast<unsigned>(bits >> 32));
170 }
171
172 // Macro that returns a compile time constant with the length of an array, but gives an error if passed a non-array.
173 template<typename T, size_t Size> char (&ArrayLengthHelperFunction(T (&)[Size]))[Size];
174 // GCC needs some help to deduce a 0 length array.
175 #if COMPILER(GCC_OR_CLANG)
176 template<typename T> char (&ArrayLengthHelperFunction(T (&)[0]))[0];
177 #endif
178 #define WTF_ARRAY_LENGTH(array) sizeof(::WTF::ArrayLengthHelperFunction(array))
179
180 // Efficient implementation that takes advantage of powers of two.
181 inline size_t roundUpToMultipleOf(size_t divisor, size_t x)
182 {
183     ASSERT(divisor && !(divisor & (divisor - 1)));
184     size_t remainderMask = divisor - 1;
185     return (x + remainderMask) & ~remainderMask;
186 }
187
188 template<size_t divisor> inline size_t roundUpToMultipleOf(size_t x)
189 {
190     static_assert(divisor && !(divisor & (divisor - 1)), "divisor must be a power of two!");
191     return roundUpToMultipleOf(divisor, x);
192 }
193
194 enum BinarySearchMode {
195     KeyMustBePresentInArray,
196     KeyMightNotBePresentInArray,
197     ReturnAdjacentElementIfKeyIsNotPresent
198 };
199
200 template<typename ArrayElementType, typename KeyType, typename ArrayType, typename ExtractKey, BinarySearchMode mode>
201 inline ArrayElementType* binarySearchImpl(ArrayType& array, size_t size, KeyType key, const ExtractKey& extractKey = ExtractKey())
202 {
203     size_t offset = 0;
204     while (size > 1) {
205         size_t pos = (size - 1) >> 1;
206         KeyType val = extractKey(&array[offset + pos]);
207         
208         if (val == key)
209             return &array[offset + pos];
210         // The item we are looking for is smaller than the item being check; reduce the value of 'size',
211         // chopping off the right hand half of the array.
212         if (key < val)
213             size = pos;
214         // Discard all values in the left hand half of the array, up to and including the item at pos.
215         else {
216             size -= (pos + 1);
217             offset += (pos + 1);
218         }
219
220         ASSERT(mode != KeyMustBePresentInArray || size);
221     }
222     
223     if (mode == KeyMightNotBePresentInArray && !size)
224         return 0;
225     
226     ArrayElementType* result = &array[offset];
227
228     if (mode == KeyMightNotBePresentInArray && key != extractKey(result))
229         return 0;
230
231     if (mode == KeyMustBePresentInArray) {
232         ASSERT(size == 1);
233         ASSERT(key == extractKey(result));
234     }
235
236     return result;
237 }
238
239 // If the element is not found, crash if asserts are enabled, and behave like approximateBinarySearch in release builds.
240 template<typename ArrayElementType, typename KeyType, typename ArrayType, typename ExtractKey>
241 inline ArrayElementType* binarySearch(ArrayType& array, size_t size, KeyType key, ExtractKey extractKey = ExtractKey())
242 {
243     return binarySearchImpl<ArrayElementType, KeyType, ArrayType, ExtractKey, KeyMustBePresentInArray>(array, size, key, extractKey);
244 }
245
246 // Return zero if the element is not found.
247 template<typename ArrayElementType, typename KeyType, typename ArrayType, typename ExtractKey>
248 inline ArrayElementType* tryBinarySearch(ArrayType& array, size_t size, KeyType key, ExtractKey extractKey = ExtractKey())
249 {
250     return binarySearchImpl<ArrayElementType, KeyType, ArrayType, ExtractKey, KeyMightNotBePresentInArray>(array, size, key, extractKey);
251 }
252
253 // Return the element that is either to the left, or the right, of where the element would have been found.
254 template<typename ArrayElementType, typename KeyType, typename ArrayType, typename ExtractKey>
255 inline ArrayElementType* approximateBinarySearch(ArrayType& array, size_t size, KeyType key, ExtractKey extractKey = ExtractKey())
256 {
257     return binarySearchImpl<ArrayElementType, KeyType, ArrayType, ExtractKey, ReturnAdjacentElementIfKeyIsNotPresent>(array, size, key, extractKey);
258 }
259
260 // Variants of the above that use const.
261 template<typename ArrayElementType, typename KeyType, typename ArrayType, typename ExtractKey>
262 inline ArrayElementType* binarySearch(const ArrayType& array, size_t size, KeyType key, ExtractKey extractKey = ExtractKey())
263 {
264     return binarySearchImpl<ArrayElementType, KeyType, ArrayType, ExtractKey, KeyMustBePresentInArray>(const_cast<ArrayType&>(array), size, key, extractKey);
265 }
266 template<typename ArrayElementType, typename KeyType, typename ArrayType, typename ExtractKey>
267 inline ArrayElementType* tryBinarySearch(const ArrayType& array, size_t size, KeyType key, ExtractKey extractKey = ExtractKey())
268 {
269     return binarySearchImpl<ArrayElementType, KeyType, ArrayType, ExtractKey, KeyMightNotBePresentInArray>(const_cast<ArrayType&>(array), size, key, extractKey);
270 }
271 template<typename ArrayElementType, typename KeyType, typename ArrayType, typename ExtractKey>
272 inline ArrayElementType* approximateBinarySearch(const ArrayType& array, size_t size, KeyType key, ExtractKey extractKey = ExtractKey())
273 {
274     return binarySearchImpl<ArrayElementType, KeyType, ArrayType, ExtractKey, ReturnAdjacentElementIfKeyIsNotPresent>(const_cast<ArrayType&>(array), size, key, extractKey);
275 }
276
277 template<typename VectorType, typename ElementType>
278 inline void insertIntoBoundedVector(VectorType& vector, size_t size, const ElementType& element, size_t index)
279 {
280     for (size_t i = size; i-- > index + 1;)
281         vector[i] = vector[i - 1];
282     vector[index] = element;
283 }
284
285 // This is here instead of CompilationThread.h to prevent that header from being included
286 // everywhere. The fact that this method, and that header, exist outside of JSC is a bug.
287 // https://bugs.webkit.org/show_bug.cgi?id=131815
288 WTF_EXPORT_PRIVATE bool isCompilationThread();
289
290 template<typename Func>
291 bool isStatelessLambda()
292 {
293     return std::is_empty<Func>::value;
294 }
295
296 template<typename ResultType, typename Func, typename... ArgumentTypes>
297 ResultType callStatelessLambda(ArgumentTypes&&... arguments)
298 {
299     uint64_t data[(sizeof(Func) + sizeof(uint64_t) - 1) / sizeof(uint64_t)];
300     memset(data, 0, sizeof(data));
301     return (*bitwise_cast<Func*>(data))(std::forward<ArgumentTypes>(arguments)...);
302 }
303
304 template<typename T, typename U>
305 bool checkAndSet(T& left, U right)
306 {
307     if (left == right)
308         return false;
309     left = right;
310     return true;
311 }
312
313 // Visitor adapted from http://stackoverflow.com/questions/25338795/is-there-a-name-for-this-tuple-creation-idiom
314
315 template <class A, class... B>
316 struct Visitor : Visitor<A>, Visitor<B...> {
317     Visitor(A a, B... b)
318         : Visitor<A>(a)
319         , Visitor<B...>(b...)
320     {
321     }
322
323     using Visitor<A>::operator ();
324     using Visitor<B...>::operator ();
325 };
326   
327 template <class A>
328 struct Visitor<A> : A {
329     Visitor(A a)
330         : A(a)
331     {
332     }
333
334     using A::operator();
335 };
336  
337 template <class... F>
338 auto makeVisitor(F... f)
339 {
340     return Visitor<F...>(f...);
341 }
342
343 } // namespace WTF
344
345 // This version of placement new omits a 0 check.
346 enum NotNullTag { NotNull };
347 inline void* operator new(size_t, NotNullTag, void* location)
348 {
349     ASSERT(location);
350     return location;
351 }
352
353 // This adds various C++14 features for versions of the STL that may not yet have them.
354 namespace std {
355 #if COMPILER(CLANG) && __cplusplus < 201400L
356 template<class T> struct _Unique_if {
357     typedef unique_ptr<T> _Single_object;
358 };
359
360 template<class T> struct _Unique_if<T[]> {
361     typedef unique_ptr<T[]> _Unknown_bound;
362 };
363
364 template<class T, size_t N> struct _Unique_if<T[N]> {
365     typedef void _Known_bound;
366 };
367
368 template<class T, class... Args> inline typename _Unique_if<T>::_Single_object
369 make_unique(Args&&... args)
370 {
371     return unique_ptr<T>(new T(std::forward<Args>(args)...));
372 }
373
374 template<class T> inline typename _Unique_if<T>::_Unknown_bound
375 make_unique(size_t n)
376 {
377     typedef typename remove_extent<T>::type U;
378     return unique_ptr<T>(new U[n]());
379 }
380
381 template<class T, class... Args> typename _Unique_if<T>::_Known_bound
382 make_unique(Args&&...) = delete;
383
384 // std::exchange
385 template<class T, class U = T>
386 T exchange(T& t, U&& newValue)
387 {
388     T oldValue = std::move(t);
389     t = std::forward<U>(newValue);
390
391     return oldValue;
392 }
393 #endif
394
395 template<WTF::CheckMoveParameterTag, typename T>
396 ALWAYS_INLINE constexpr typename remove_reference<T>::type&& move(T&& value)
397 {
398     static_assert(is_lvalue_reference<T>::value, "T is not an lvalue reference; move() is unnecessary.");
399
400     using NonRefQualifiedType = typename remove_reference<T>::type;
401     static_assert(!is_const<NonRefQualifiedType>::value, "T is const qualified.");
402
403     return move(forward<T>(value));
404 }
405
406 #if !COMPILER(CLANG) || WTF_CPP_STD_VER >= 14
407
408 template<typename... Types>
409 using variant = std::experimental::variant<Types...>;
410
411 using std::experimental::get;
412 using std::experimental::get_if;
413 using std::experimental::holds_alternative;
414 using std::experimental::visit;
415
416 #endif
417
418 } // namespace std
419
420 #define WTFMove(value) std::move<WTF::CheckMoveParameter>(value)
421
422 using WTF::KB;
423 using WTF::MB;
424 using WTF::approximateBinarySearch;
425 using WTF::binarySearch;
426 using WTF::bitwise_cast;
427 using WTF::callStatelessLambda;
428 using WTF::checkAndSet;
429 using WTF::insertIntoBoundedVector;
430 using WTF::isCompilationThread;
431 using WTF::isPointerAligned;
432 using WTF::isStatelessLambda;
433 using WTF::is8ByteAligned;
434 using WTF::safeCast;
435 using WTF::tryBinarySearch;
436
437 #if !COMPILER(CLANG) || __cplusplus >= 201400L
438 // We normally don't want to bring in entire std namespaces, but literals are an exception.
439 using namespace std::literals::chrono_literals;
440 #endif
441
442 #endif // WTF_StdLibExtras_h