Unreviewed, rolling out r178068.
[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_CONSTEXPR __has_feature(cxx_constexpr)
54 #define WTF_COMPILER_SUPPORTS_CXX_REFERENCE_QUALIFIED_FUNCTIONS __has_feature(cxx_reference_qualified_functions)
55 #define WTF_COMPILER_SUPPORTS_CXX_USER_LITERALS __has_feature(cxx_user_literals)
56 #define WTF_COMPILER_SUPPORTS_FALLTHROUGH_WARNINGS __has_feature(cxx_attributes) && __has_warning("-Wimplicit-fallthrough")
57 #endif
58
59 /* COMPILER(GCC) - GNU Compiler Collection */
60
61 /* Note: This section must come after the Clang section since we check !COMPILER(CLANG) here. */
62
63 #if defined(__GNUC__)
64 #define WTF_COMPILER_GCC 1
65 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
66 #define GCC_VERSION_AT_LEAST(major, minor, patch) (GCC_VERSION >= (major * 10000 + minor * 100 + patch))
67 #endif
68
69 /* Define GCC_VERSION_AT_LEAST for all compilers, so we can write things like GCC_VERSION_AT_LEAST(4, 1, 0). */
70 /* FIXME: Doesn't seem all that valuable. Can we remove this? */
71 #if !defined(GCC_VERSION_AT_LEAST)
72 #define GCC_VERSION_AT_LEAST(major, minor, patch) 0
73 #endif
74
75 #if COMPILER(GCC) && !COMPILER(CLANG) && !GCC_VERSION_AT_LEAST(4, 7, 0)
76 #error "Please use a newer version of GCC. WebKit requires GCC 4.7.0 or newer to compile."
77 #endif
78
79 #if COMPILER(GCC) && !COMPILER(CLANG)
80 #define WTF_COMPILER_SUPPORTS_CXX_CONSTEXPR 1
81 #define WTF_COMPILER_SUPPORTS_CXX_USER_LITERALS 1
82 #endif
83
84 #if !COMPILER(CLANG)
85 #define WTF_COMPILER_QUIRK_CONSIDERS_UNREACHABLE_CODE 1
86 #endif
87
88 #if COMPILER(GCC) && !COMPILER(CLANG) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
89 #define WTF_COMPILER_SUPPORTS_C_STATIC_ASSERT 1
90 #endif
91
92 #if COMPILER(GCC) && !COMPILER(CLANG) && GCC_VERSION_AT_LEAST(4, 8, 0)
93 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
94 #endif
95
96 #if COMPILER(GCC) && !COMPILER(CLANG) && (defined(__GXX_EXPERIMENTAL_CXX0X__) || (defined(__cplusplus) && __cplusplus >= 201103L))
97 #pragma GCC diagnostic ignored "-Wunused-local-typedefs"
98 #endif
99
100 /* COMPILER(MINGW) - MinGW GCC */
101
102 #if defined(__MINGW32__)
103 #define WTF_COMPILER_MINGW 1
104 #include <_mingw.h>
105 #endif
106
107 /* COMPILER(MINGW64) - mingw-w64 GCC - used as additional check to exclude mingw.org specific functions */
108
109 /* Note: This section must come after the MinGW section since we check COMPILER(MINGW) here. */
110
111 #if COMPILER(MINGW) && defined(__MINGW64_VERSION_MAJOR) /* best way to check for mingw-w64 vs mingw.org */
112 #define WTF_COMPILER_MINGW64 1
113 #endif
114
115 /* COMPILER(MSVC) - Microsoft Visual C++ */
116
117 #if defined(_MSC_VER)
118 #define WTF_COMPILER_MSVC 1
119 #endif
120
121 #if defined(_MSC_VER) && _MSC_VER < 1800
122 #error "Please use a newer version of Visual Studio. WebKit requires VS2013 or newer to compile."
123 #endif
124
125 /* COMPILER(SUNCC) */
126
127 #if defined(__SUNPRO_CC) || defined(__SUNPRO_C)
128 #define WTF_COMPILER_SUNCC 1
129 #endif
130
131 /* ==== COMPILER_SUPPORTS - additional compiler feature detection, in alphabetical order ==== */
132
133 /* COMPILER_SUPPORTS(EABI) */
134
135 #if defined(__ARM_EABI__) || defined(__EABI__)
136 #define WTF_COMPILER_SUPPORTS_EABI 1
137 #endif
138
139 #if defined(__has_feature)
140 #define ASAN_ENABLED __has_feature(address_sanitizer)
141 #else
142 #define ASAN_ENABLED false
143 #endif
144
145 /* ==== Compiler-independent macros for various compiler features, in alphabetical order ==== */
146
147 /* ALWAYS_INLINE */
148
149 #if !defined(ALWAYS_INLINE) && COMPILER(GCC) && defined(NDEBUG) && !COMPILER(MINGW)
150 #define ALWAYS_INLINE inline __attribute__((__always_inline__))
151 #endif
152
153 #if !defined(ALWAYS_INLINE) && COMPILER(MSVC) && defined(NDEBUG)
154 #define ALWAYS_INLINE __forceinline
155 #endif
156
157 #if !defined(ALWAYS_INLINE)
158 #define ALWAYS_INLINE inline
159 #endif
160
161 /* CONSTEXPR */
162
163 #if !defined(CONSTEXPR) && COMPILER_SUPPORTS(CXX_CONSTEXPR)
164 #define CONSTEXPR constexpr
165 #endif
166
167 #if !defined(CONSTEXPR)
168 #define CONSTEXPR
169 #endif
170
171 /* EXTERN_C */
172
173 #ifdef __cplusplus
174 #define EXTERN_C extern "C"
175 #else
176 #define EXTERN_C extern
177 #endif
178
179 /* FALLTHROUGH */
180
181 #if !defined(FALLTHROUGH) && COMPILER_SUPPORTS(FALLTHROUGH_WARNINGS) && COMPILER(CLANG)
182 #define FALLTHROUGH [[clang::fallthrough]]
183 #endif
184
185 #if !defined(FALLTHROUGH)
186 #define FALLTHROUGH
187 #endif
188
189 /* LIKELY */
190
191 #if !defined(LIKELY) && COMPILER(GCC)
192 #define LIKELY(x) __builtin_expect(!!(x), 1)
193 #endif
194
195 #if !defined(LIKELY)
196 #define LIKELY(x) (x)
197 #endif
198
199 /* NEVER_INLINE */
200
201 #if !defined(NEVER_INLINE) && COMPILER(GCC)
202 #define NEVER_INLINE __attribute__((__noinline__))
203 #endif
204
205 #if !defined(NEVER_INLINE) && COMPILER(MSVC)
206 #define NEVER_INLINE __declspec(noinline)
207 #endif
208
209 #if !defined(NEVER_INLINE)
210 #define NEVER_INLINE
211 #endif
212
213 /* NO_RETURN */
214
215 #if !defined(NO_RETURN) && COMPILER(GCC)
216 #define NO_RETURN __attribute((__noreturn__))
217 #endif
218
219 #if !defined(NO_RETURN) && COMPILER(MSVC)
220 #define NO_RETURN __declspec(noreturn)
221 #endif
222
223 #if !defined(NO_RETURN)
224 #define NO_RETURN
225 #endif
226
227 /* NO_RETURN_WITH_VALUE */
228
229 #if !defined(NO_RETURN_WITH_VALUE) && !COMPILER(MSVC)
230 #define NO_RETURN_WITH_VALUE NO_RETURN
231 #endif
232
233 #if !defined(NO_RETURN_WITH_VALUE)
234 #define NO_RETURN_WITH_VALUE
235 #endif
236
237 /* OBJC_CLASS */
238
239 #if !defined(OBJC_CLASS) && defined(__OBJC__)
240 #define OBJC_CLASS @class
241 #endif
242
243 #if !defined(OBJC_CLASS)
244 #define OBJC_CLASS class
245 #endif
246
247 /* PURE_FUNCTION */
248
249 #if !defined(PURE_FUNCTION) && COMPILER(GCC)
250 #define PURE_FUNCTION __attribute__((__pure__))
251 #endif
252
253 #if !defined(PURE_FUNCTION)
254 #define PURE_FUNCTION
255 #endif
256
257 /* REFERENCED_FROM_ASM */
258
259 #if !defined(REFERENCED_FROM_ASM) && COMPILER(GCC)
260 #define REFERENCED_FROM_ASM __attribute__((__used__))
261 #endif
262
263 #if !defined(REFERENCED_FROM_ASM)
264 #define REFERENCED_FROM_ASM
265 #endif
266
267 /* UNLIKELY */
268
269 #if !defined(UNLIKELY) && COMPILER(GCC)
270 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
271 #endif
272
273 #if !defined(UNLIKELY)
274 #define UNLIKELY(x) (x)
275 #endif
276
277 /* UNUSED_LABEL */
278
279 /* Keep the compiler from complaining for a local label that is defined but not referenced. */
280 /* Helpful when mixing hand-written and autogenerated code. */
281
282 #if !defined(UNUSED_LABEL) && COMPILER(MSVC)
283 #define UNUSED_LABEL(label) if (false) goto label
284 #endif
285
286 #if !defined(UNUSED_LABEL)
287 #define UNUSED_LABEL(label) UNUSED_PARAM(&& label)
288 #endif
289
290 /* UNUSED_PARAM */
291
292 #if !defined(UNUSED_PARAM) && COMPILER(MSVC)
293 #define UNUSED_PARAM(variable) (void)&variable
294 #endif
295
296 #if !defined(UNUSED_PARAM)
297 #define UNUSED_PARAM(variable) (void)variable
298 #endif
299
300 /* WARN_UNUSED_RETURN */
301
302 #if !defined(WARN_UNUSED_RETURN) && COMPILER(GCC)
303 #define WARN_UNUSED_RETURN __attribute__((__warn_unused_result__))
304 #endif
305
306 #if !defined(WARN_UNUSED_RETURN)
307 #define WARN_UNUSED_RETURN
308 #endif
309
310 #if !defined(__has_include) && COMPILER(MSVC)
311 #define __has_include(path) 0
312 #endif
313
314 #endif /* WTF_Compiler_h */