Nullopt and InPlace should be structs, not enum values
[WebKit-https.git] / Source / WTF / wtf / Compiler.h
1 /*
2  * Copyright (C) 2011, 2012, 2014 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef WTF_Compiler_h
27 #define WTF_Compiler_h
28
29 /* COMPILER() - the compiler being used to build the project */
30 #define COMPILER(WTF_FEATURE) (defined WTF_COMPILER_##WTF_FEATURE  && WTF_COMPILER_##WTF_FEATURE)
31
32 /* COMPILER_SUPPORTS() - whether the compiler being used to build the project supports the given feature. */
33 #define COMPILER_SUPPORTS(WTF_COMPILER_FEATURE) (defined WTF_COMPILER_SUPPORTS_##WTF_COMPILER_FEATURE  && WTF_COMPILER_SUPPORTS_##WTF_COMPILER_FEATURE)
34
35 /* COMPILER_QUIRK() - whether the compiler being used to build the project requires a given quirk. */
36 #define COMPILER_QUIRK(WTF_COMPILER_QUIRK) (defined WTF_COMPILER_QUIRK_##WTF_COMPILER_QUIRK  && WTF_COMPILER_QUIRK_##WTF_COMPILER_QUIRK)
37
38 /* COMPILER_HAS_CLANG_BUILTIN() - wether the compiler supports a particular clang builtin. */
39 #ifdef __has_builtin
40 #define COMPILER_HAS_CLANG_BUILTIN(x) __has_builtin(x)
41 #else
42 #define COMPILER_HAS_CLANG_BUILTIN(x) 0
43 #endif
44
45 /* ==== COMPILER() - primary detection of the compiler being used to build the project, in alphabetical order ==== */
46
47 /* COMPILER(CLANG) - Clang  */
48
49 #if defined(__clang__)
50 #define WTF_COMPILER_CLANG 1
51 #define WTF_COMPILER_SUPPORTS_BLOCKS __has_feature(blocks)
52 #define WTF_COMPILER_SUPPORTS_C_STATIC_ASSERT __has_feature(c_static_assert)
53 #define WTF_COMPILER_SUPPORTS_CXX_REFERENCE_QUALIFIED_FUNCTIONS __has_feature(cxx_reference_qualified_functions)
54 #define WTF_COMPILER_SUPPORTS_CXX_USER_LITERALS __has_feature(cxx_user_literals)
55 #define WTF_COMPILER_SUPPORTS_FALLTHROUGH_WARNINGS __has_feature(cxx_attributes) && __has_warning("-Wimplicit-fallthrough")
56 #endif
57
58 /* COMPILER(GCC_OR_CLANG) - GNU Compiler Collection or Clang */
59 #if defined(__GNUC__)
60 #define WTF_COMPILER_GCC_OR_CLANG 1
61 #endif
62
63 /* COMPILER(GCC) - GNU Compiler Collection */
64 /* Note: This section must come after the Clang section since we check !COMPILER(CLANG) here. */
65 #if COMPILER(GCC_OR_CLANG) && !COMPILER(CLANG)
66 #define WTF_COMPILER_GCC 1
67 #define WTF_COMPILER_SUPPORTS_CXX_USER_LITERALS 1
68 #define WTF_COMPILER_SUPPORTS_CXX_REFERENCE_QUALIFIED_FUNCTIONS 1
69
70 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
71 #define GCC_VERSION_AT_LEAST(major, minor, patch) (GCC_VERSION >= (major * 10000 + minor * 100 + patch))
72
73 #if !GCC_VERSION_AT_LEAST(4, 9, 0)
74 #error "Please use a newer version of GCC. WebKit requires GCC 4.9.0 or newer to compile."
75 #endif
76
77 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
78 #define WTF_COMPILER_SUPPORTS_C_STATIC_ASSERT 1
79 #endif
80
81 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
82
83 #endif /* COMPILER(GCC) */
84
85 /* COMPILER(MINGW) - MinGW GCC */
86
87 #if defined(__MINGW32__)
88 #define WTF_COMPILER_MINGW 1
89 #include <_mingw.h>
90 #endif
91
92 /* COMPILER(MINGW64) - mingw-w64 GCC - used as additional check to exclude mingw.org specific functions */
93
94 /* Note: This section must come after the MinGW section since we check COMPILER(MINGW) here. */
95
96 #if COMPILER(MINGW) && defined(__MINGW64_VERSION_MAJOR) /* best way to check for mingw-w64 vs mingw.org */
97 #define WTF_COMPILER_MINGW64 1
98 #endif
99
100 /* COMPILER(MSVC) - Microsoft Visual C++ */
101
102 #if defined(_MSC_VER)
103 #define WTF_COMPILER_MSVC 1
104 #endif
105
106 #if defined(_MSC_VER) && _MSC_VER < 1800
107 #error "Please use a newer version of Visual Studio. WebKit requires VS2013 or newer to compile."
108 #endif
109
110 /* COMPILER(SUNCC) */
111
112 #if defined(__SUNPRO_CC) || defined(__SUNPRO_C)
113 #define WTF_COMPILER_SUNCC 1
114 #endif
115
116 #if !COMPILER(CLANG) && !COMPILER(MSVC)
117 #define WTF_COMPILER_QUIRK_CONSIDERS_UNREACHABLE_CODE 1
118 #endif
119
120 /* ==== COMPILER_SUPPORTS - additional compiler feature detection, in alphabetical order ==== */
121
122 /* COMPILER_SUPPORTS(EABI) */
123
124 #if defined(__ARM_EABI__) || defined(__EABI__)
125 #define WTF_COMPILER_SUPPORTS_EABI 1
126 #endif
127
128 #if defined(__has_feature)
129 #define ASAN_ENABLED __has_feature(address_sanitizer)
130 #else
131 #define ASAN_ENABLED 0
132 #endif
133
134 #if ASAN_ENABLED
135 #define SUPPRESS_ASAN __attribute__((no_sanitize_address))
136 #else
137 #define SUPPRESS_ASAN
138 #endif
139
140 /* ==== Compiler-independent macros for various compiler features, in alphabetical order ==== */
141
142 /* ALWAYS_INLINE */
143
144 #if !defined(ALWAYS_INLINE) && COMPILER(GCC_OR_CLANG) && defined(NDEBUG) && !COMPILER(MINGW)
145 #define ALWAYS_INLINE inline __attribute__((__always_inline__))
146 #endif
147
148 #if !defined(ALWAYS_INLINE) && COMPILER(MSVC) && defined(NDEBUG)
149 #define ALWAYS_INLINE __forceinline
150 #endif
151
152 #if !defined(ALWAYS_INLINE)
153 #define ALWAYS_INLINE inline
154 #endif
155
156 /* WTF_EXTERN_C_{BEGIN, END} */
157
158 #ifdef __cplusplus
159 #define WTF_EXTERN_C_BEGIN extern "C" {
160 #define WTF_EXTERN_C_END }
161 #else
162 #define WTF_EXTERN_C_BEGIN
163 #define WTF_EXTERN_C_END
164 #endif
165
166 /* FIXME: Remove this once we have transitioned to WTF_EXTERN_C_BEGIN/WTF_EXTERN_C_END. */
167 #ifdef __cplusplus
168 #define EXTERN_C extern "C"
169 #else
170 #define EXTERN_C extern
171 #endif
172
173 /* FALLTHROUGH */
174
175 #if !defined(FALLTHROUGH) && COMPILER_SUPPORTS(FALLTHROUGH_WARNINGS) && COMPILER(CLANG)
176 #define FALLTHROUGH [[clang::fallthrough]]
177 #endif
178
179 #if !defined(FALLTHROUGH)
180 #define FALLTHROUGH
181 #endif
182
183 /* LIKELY */
184
185 #if !defined(LIKELY) && COMPILER(GCC_OR_CLANG)
186 #define LIKELY(x) __builtin_expect(!!(x), 1)
187 #endif
188
189 #if !defined(LIKELY)
190 #define LIKELY(x) (x)
191 #endif
192
193 /* NEVER_INLINE */
194
195 #if !defined(NEVER_INLINE) && COMPILER(GCC_OR_CLANG)
196 #define NEVER_INLINE __attribute__((__noinline__))
197 #endif
198
199 #if !defined(NEVER_INLINE) && COMPILER(MSVC)
200 #define NEVER_INLINE __declspec(noinline)
201 #endif
202
203 #if !defined(NEVER_INLINE)
204 #define NEVER_INLINE
205 #endif
206
207 /* NO_RETURN */
208
209 #if !defined(NO_RETURN) && COMPILER(GCC_OR_CLANG)
210 #define NO_RETURN __attribute((__noreturn__))
211 #endif
212
213 #if !defined(NO_RETURN) && COMPILER(MSVC)
214 #define NO_RETURN __declspec(noreturn)
215 #endif
216
217 #if !defined(NO_RETURN)
218 #define NO_RETURN
219 #endif
220
221 /* NO_RETURN_WITH_VALUE */
222
223 #if !defined(NO_RETURN_WITH_VALUE) && !COMPILER(MSVC)
224 #define NO_RETURN_WITH_VALUE NO_RETURN
225 #endif
226
227 #if !defined(NO_RETURN_WITH_VALUE)
228 #define NO_RETURN_WITH_VALUE
229 #endif
230
231 /* OBJC_CLASS */
232
233 #if !defined(OBJC_CLASS) && defined(__OBJC__)
234 #define OBJC_CLASS @class
235 #endif
236
237 #if !defined(OBJC_CLASS)
238 #define OBJC_CLASS class
239 #endif
240
241 /* PURE_FUNCTION */
242
243 #if !defined(PURE_FUNCTION) && COMPILER(GCC_OR_CLANG)
244 #define PURE_FUNCTION __attribute__((__pure__))
245 #endif
246
247 #if !defined(PURE_FUNCTION)
248 #define PURE_FUNCTION
249 #endif
250
251 /* REFERENCED_FROM_ASM */
252
253 #if !defined(REFERENCED_FROM_ASM) && COMPILER(GCC_OR_CLANG)
254 #define REFERENCED_FROM_ASM __attribute__((__used__))
255 #endif
256
257 #if !defined(REFERENCED_FROM_ASM)
258 #define REFERENCED_FROM_ASM
259 #endif
260
261 /* UNLIKELY */
262
263 #if !defined(UNLIKELY) && COMPILER(GCC_OR_CLANG)
264 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
265 #endif
266
267 #if !defined(UNLIKELY)
268 #define UNLIKELY(x) (x)
269 #endif
270
271 /* UNUSED_LABEL */
272
273 /* Keep the compiler from complaining for a local label that is defined but not referenced. */
274 /* Helpful when mixing hand-written and autogenerated code. */
275
276 #if !defined(UNUSED_LABEL) && COMPILER(MSVC)
277 #define UNUSED_LABEL(label) if (false) goto label
278 #endif
279
280 #if !defined(UNUSED_LABEL)
281 #define UNUSED_LABEL(label) UNUSED_PARAM(&& label)
282 #endif
283
284 /* UNUSED_PARAM */
285
286 #if !defined(UNUSED_PARAM) && COMPILER(MSVC)
287 #define UNUSED_PARAM(variable) (void)&variable
288 #endif
289
290 #if !defined(UNUSED_PARAM)
291 #define UNUSED_PARAM(variable) (void)variable
292 #endif
293
294 /* WARN_UNUSED_RETURN */
295
296 #if !defined(WARN_UNUSED_RETURN) && COMPILER(GCC_OR_CLANG)
297 #define WARN_UNUSED_RETURN __attribute__((__warn_unused_result__))
298 #endif
299
300 #if !defined(WARN_UNUSED_RETURN)
301 #define WARN_UNUSED_RETURN
302 #endif
303
304 #if !defined(__has_include) && COMPILER(MSVC)
305 #define __has_include(path) 0
306 #endif
307
308 #endif /* WTF_Compiler_h */