Restore alphabetical order in Compiler.h
[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_GENERALIZED_INITIALIZERS __has_feature(cxx_generalized_initializers)
48 #define WTF_COMPILER_SUPPORTS_CXX_REFERENCE_QUALIFIED_FUNCTIONS __has_feature(cxx_reference_qualified_functions)
49 #define WTF_COMPILER_SUPPORTS_CXX_USER_LITERALS __has_feature(cxx_user_literals)
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(GCC) && !COMPILER(CLANG) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
78 #define WTF_COMPILER_SUPPORTS_C_STATIC_ASSERT 1
79 #endif
80
81 #if COMPILER(GCC) && !COMPILER(CLANG) && GCC_VERSION_AT_LEAST(4, 8, 0)
82 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
83 #endif
84
85 #if COMPILER(GCC) && !COMPILER(CLANG) && (defined(__GXX_EXPERIMENTAL_CXX0X__) || (defined(__cplusplus) && __cplusplus >= 201103L))
86 #pragma GCC diagnostic ignored "-Wunused-local-typedefs"
87 #endif
88
89 /* COMPILER(MINGW) - MinGW GCC */
90
91 #if defined(__MINGW32__)
92 #define WTF_COMPILER_MINGW 1
93 #include <_mingw.h>
94 #endif
95
96 /* COMPILER(MINGW64) - mingw-w64 GCC - used as additional check to exclude mingw.org specific functions */
97
98 /* Note: This section must come after the MinGW section since we check COMPILER(MINGW) here. */
99
100 #if COMPILER(MINGW) && defined(__MINGW64_VERSION_MAJOR) /* best way to check for mingw-w64 vs mingw.org */
101 #define WTF_COMPILER_MINGW64 1
102 #endif
103
104 /* COMPILER(MSVC) - Microsoft Visual C++ */
105
106 #if defined(_MSC_VER)
107 #define WTF_COMPILER_MSVC 1
108 #define WTF_COMPILER_SUPPORTS_CXX_GENERALIZED_INITIALIZERS 1
109 #endif
110
111 #if defined(_MSC_VER) && _MSC_VER < 1800
112 #error "Please use a newer version of Visual Studio. WebKit requires VS2013 or newer to compile."
113 #endif
114
115 /* COMPILER(SUNCC) */
116
117 #if defined(__SUNPRO_CC) || defined(__SUNPRO_C)
118 #define WTF_COMPILER_SUNCC 1
119 #endif
120
121 /* ==== COMPILER_SUPPORTS - additional compiler feature detection, in alphabetical order ==== */
122
123 /* COMPILER_SUPPORTS(EABI) */
124
125 #if defined(__ARM_EABI__) || defined(__EABI__)
126 #define WTF_COMPILER_SUPPORTS_EABI 1
127 #endif
128
129 /* ==== Compiler-independent macros for various compiler features, in alphabetical order ==== */
130
131 /* ALWAYS_INLINE */
132
133 #if !defined(ALWAYS_INLINE) && COMPILER(GCC) && defined(NDEBUG) && !COMPILER(MINGW)
134 #define ALWAYS_INLINE inline __attribute__((__always_inline__))
135 #endif
136
137 #if !defined(ALWAYS_INLINE) && COMPILER(MSVC) && defined(NDEBUG)
138 #define ALWAYS_INLINE __forceinline
139 #endif
140
141 #if !defined(ALWAYS_INLINE)
142 #define ALWAYS_INLINE inline
143 #endif
144
145 /* CONSTEXPR */
146
147 #if !defined(CONSTEXPR) && COMPILER_SUPPORTS(CXX_CONSTEXPR)
148 #define CONSTEXPR constexpr
149 #endif
150
151 #if !defined(CONSTEXPR)
152 #define CONSTEXPR
153 #endif
154
155 /* LIKELY */
156
157 #if !defined(LIKELY) && COMPILER(GCC)
158 #define LIKELY(x) __builtin_expect(!!(x), 1)
159 #endif
160
161 #if !defined(LIKELY)
162 #define LIKELY(x) (x)
163 #endif
164
165 /* NEVER_INLINE */
166
167 #if !defined(NEVER_INLINE) && COMPILER(GCC)
168 #define NEVER_INLINE __attribute__((__noinline__))
169 #endif
170
171 #if !defined(NEVER_INLINE) && COMPILER(MSVC)
172 #define NEVER_INLINE __declspec(noinline)
173 #endif
174
175 #if !defined(NEVER_INLINE)
176 #define NEVER_INLINE
177 #endif
178
179 /* NO_RETURN */
180
181 #if !defined(NO_RETURN) && COMPILER(GCC)
182 #define NO_RETURN __attribute((__noreturn__))
183 #endif
184
185 #if !defined(NO_RETURN) && COMPILER(MSVC)
186 #define NO_RETURN __declspec(noreturn)
187 #endif
188
189 #if !defined(NO_RETURN)
190 #define NO_RETURN
191 #endif
192
193 /* NO_RETURN_WITH_VALUE */
194
195 #if !defined(NO_RETURN_WITH_VALUE) && !COMPILER(MSVC)
196 #define NO_RETURN_WITH_VALUE NO_RETURN
197 #endif
198
199 #if !defined(NO_RETURN_WITH_VALUE)
200 #define NO_RETURN_WITH_VALUE
201 #endif
202
203 /* OBJC_CLASS */
204
205 #if !defined(OBJC_CLASS) && defined(__OBJC__)
206 #define OBJC_CLASS @class
207 #endif
208
209 #if !defined(OBJC_CLASS)
210 #define OBJC_CLASS class
211 #endif
212
213 /* PURE_FUNCTION */
214
215 #if !defined(PURE_FUNCTION) && COMPILER(GCC)
216 #define PURE_FUNCTION __attribute__((__pure__))
217 #endif
218
219 #if !defined(PURE_FUNCTION)
220 #define PURE_FUNCTION
221 #endif
222
223 /* REFERENCED_FROM_ASM */
224
225 #if !defined(REFERENCED_FROM_ASM) && COMPILER(GCC)
226 #define REFERENCED_FROM_ASM __attribute__((__used__))
227 #endif
228
229 #if !defined(REFERENCED_FROM_ASM)
230 #define REFERENCED_FROM_ASM
231 #endif
232
233 /* UNLIKELY */
234
235 #if !defined(UNLIKELY) && COMPILER(GCC)
236 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
237 #endif
238
239 #if !defined(UNLIKELY)
240 #define UNLIKELY(x) (x)
241 #endif
242
243 /* UNUSED_LABEL */
244
245 /* Keep the compiler from complaining for a local label that is defined but not referenced. */
246 /* Helpful when mixing hand-written and autogenerated code. */
247
248 #if !defined(UNUSED_LABEL) && COMPILER(MSVC)
249 #define UNUSED_LABEL(label) if (false) goto label
250 #endif
251
252 #if !defined(UNUSED_LABEL)
253 #define UNUSED_LABEL(label) UNUSED_PARAM(&& label)
254 #endif
255
256 /* UNUSED_PARAM */
257
258 #if !defined(UNUSED_PARAM) && COMPILER(MSVC)
259 #define UNUSED_PARAM(variable) (void)&variable
260 #endif
261
262 #if !defined(UNUSED_PARAM)
263 #define UNUSED_PARAM(variable) (void)variable
264 #endif
265
266 /* WARN_UNUSED_RETURN */
267
268 #if !defined(WARN_UNUSED_RETURN) && COMPILER(GCC)
269 #define WARN_UNUSED_RETURN __attribute__((__warn_unused_result__))
270 #endif
271
272 #if !defined(WARN_UNUSED_RETURN)
273 #define WARN_UNUSED_RETURN
274 #endif
275
276 #endif /* WTF_Compiler_h */