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