The 'global isinf/isnan' compiler quirk required when using clang with libstdc++
[WebKit-https.git] / Source / WTF / wtf / Compiler.h
1 /*
2  * Copyright (C) 2011, 2012 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() - the compiler being used to build the project ==== */
39
40 /* COMPILER(CLANG) - Clang  */
41 #if defined(__clang__)
42 #define WTF_COMPILER_CLANG 1
43
44 #ifndef __has_extension
45 #define __has_extension __has_feature /* Compatibility with older versions of clang */
46 #endif
47
48 #define CLANG_PRAGMA(PRAGMA) _Pragma(PRAGMA)
49
50 /* Specific compiler features */
51 #define WTF_COMPILER_SUPPORTS_CXX_VARIADIC_TEMPLATES __has_extension(cxx_variadic_templates)
52
53 /* There is a bug in clang that comes with Xcode 4.2 where AtomicStrings can't be implicitly converted to Strings
54    in the presence of move constructors and/or move assignment operators. This bug has been fixed in Xcode 4.3 clang, so we
55    check for both cxx_rvalue_references as well as the unrelated cxx_nonstatic_member_init feature which we know was added in 4.3 */
56 #define WTF_COMPILER_SUPPORTS_CXX_RVALUE_REFERENCES __has_extension(cxx_rvalue_references) && __has_extension(cxx_nonstatic_member_init)
57
58 #define WTF_COMPILER_SUPPORTS_CXX_DELETED_FUNCTIONS __has_extension(cxx_deleted_functions)
59 #define WTF_COMPILER_SUPPORTS_CXX_NULLPTR __has_feature(cxx_nullptr)
60 #define WTF_COMPILER_SUPPORTS_CXX_EXPLICIT_CONVERSIONS __has_feature(cxx_explicit_conversions)
61 #define WTF_COMPILER_SUPPORTS_BLOCKS __has_feature(blocks)
62 #define WTF_COMPILER_SUPPORTS_C_STATIC_ASSERT __has_extension(c_static_assert)
63 #define WTF_COMPILER_SUPPORTS_CXX_OVERRIDE_CONTROL __has_extension(cxx_override_control)
64 #define WTF_COMPILER_SUPPORTS_HAS_TRIVIAL_DESTRUCTOR __has_extension(has_trivial_destructor)
65 #define WTF_COMPILER_SUPPORTS_CXX_STRONG_ENUMS __has_extension(cxx_strong_enums)
66
67 #endif
68
69 #ifndef CLANG_PRAGMA
70 #define CLANG_PRAGMA(PRAGMA)
71 #endif
72
73 /* COMPILER(MSVC) - Microsoft Visual C++ */
74 /* COMPILER(MSVC7_OR_LOWER) - Microsoft Visual C++ 2003 or lower*/
75 /* COMPILER(MSVC9_OR_LOWER) - Microsoft Visual C++ 2008 or lower*/
76 #if defined(_MSC_VER)
77 #define WTF_COMPILER_MSVC 1
78 #if _MSC_VER < 1400
79 #define WTF_COMPILER_MSVC7_OR_LOWER 1
80 #elif _MSC_VER < 1600
81 #define WTF_COMPILER_MSVC9_OR_LOWER 1
82 #endif
83
84 /* Specific compiler features */
85 #if !COMPILER(CLANG) && _MSC_VER >= 1600
86 #define WTF_COMPILER_SUPPORTS_CXX_NULLPTR 1
87 #endif
88
89 #if !COMPILER(CLANG)
90 #define WTF_COMPILER_SUPPORTS_CXX_OVERRIDE_CONTROL 1
91 #define WTF_COMPILER_QUIRK_FINAL_IS_CALLED_SEALED 1
92 #endif
93
94 #endif
95
96 /* COMPILER(RVCT) - ARM RealView Compilation Tools */
97 /* COMPILER(RVCT4_OR_GREATER) - ARM RealView Compilation Tools 4.0 or greater */
98 #if defined(__CC_ARM) || defined(__ARMCC__)
99 #define WTF_COMPILER_RVCT 1
100 #define RVCT_VERSION_AT_LEAST(major, minor, patch, build) (__ARMCC_VERSION >= (major * 100000 + minor * 10000 + patch * 1000 + build))
101 #else
102 /* Define this for !RVCT compilers, just so we can write things like RVCT_VERSION_AT_LEAST(3, 0, 0, 0). */
103 #define RVCT_VERSION_AT_LEAST(major, minor, patch, build) 0
104 #endif
105
106 /* COMPILER(GCCE) - GNU Compiler Collection for Embedded */
107 #if defined(__GCCE__)
108 #define WTF_COMPILER_GCCE 1
109 #define GCCE_VERSION (__GCCE__ * 10000 + __GCCE_MINOR__ * 100 + __GCCE_PATCHLEVEL__)
110 #define GCCE_VERSION_AT_LEAST(major, minor, patch) (GCCE_VERSION >= (major * 10000 + minor * 100 + patch))
111 #endif
112
113 /* COMPILER(GCC) - GNU Compiler Collection */
114 /* --gnu option of the RVCT compiler also defines __GNUC__ */
115 #if defined(__GNUC__) && !COMPILER(RVCT)
116 #define WTF_COMPILER_GCC 1
117 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
118 #define GCC_VERSION_AT_LEAST(major, minor, patch) (GCC_VERSION >= (major * 10000 + minor * 100 + patch))
119 #else
120 /* Define this for !GCC compilers, just so we can write things like GCC_VERSION_AT_LEAST(4, 1, 0). */
121 #define GCC_VERSION_AT_LEAST(major, minor, patch) 0
122 #endif
123
124 /* Specific compiler features */
125 #if COMPILER(GCC) && !COMPILER(CLANG)
126 #if GCC_VERSION_AT_LEAST(4, 7, 0) && defined(__cplusplus) && __cplusplus >= 201103L
127 #define WTF_COMPILER_SUPPORTS_CXX_RVALUE_REFERENCES 1
128 #define WTF_COMPILER_SUPPORTS_CXX_DELETED_FUNCTIONS 1
129 #define WTF_COMPILER_SUPPORTS_CXX_NULLPTR 1
130 #define WTF_COMPILER_SUPPORTS_CXX_OVERRIDE_CONTROL 1
131
132 #elif GCC_VERSION_AT_LEAST(4, 6, 0) && defined(__GXX_EXPERIMENTAL_CXX0X__)
133 #define WTF_COMPILER_SUPPORTS_CXX_NULLPTR 1 
134 #endif
135
136 #endif
137
138 /* COMPILER(MINGW) - MinGW GCC */
139 /* COMPILER(MINGW64) - mingw-w64 GCC - only used as additional check to exclude mingw.org specific functions */
140 #if defined(__MINGW32__)
141 #define WTF_COMPILER_MINGW 1
142 #include <_mingw.h> /* private MinGW header */
143     #if defined(__MINGW64_VERSION_MAJOR) /* best way to check for mingw-w64 vs mingw.org */
144         #define WTF_COMPILER_MINGW64 1
145     #endif /* __MINGW64_VERSION_MAJOR */
146 #endif /* __MINGW32__ */
147
148 /* COMPILER(INTEL) - Intel C++ Compiler */
149 #if defined(__INTEL_COMPILER)
150 #define WTF_COMPILER_INTEL 1
151 #endif
152
153 /* COMPILER(SUNCC) */
154 #if defined(__SUNPRO_CC) || defined(__SUNPRO_C)
155 #define WTF_COMPILER_SUNCC 1
156 #endif
157
158 /* ==== Compiler features ==== */
159
160
161 /* ALWAYS_INLINE */
162
163 #ifndef ALWAYS_INLINE
164 #if COMPILER(GCC) && defined(NDEBUG) && !COMPILER(MINGW)
165 #define ALWAYS_INLINE inline __attribute__((__always_inline__))
166 #elif (COMPILER(MSVC) || COMPILER(RVCT)) && defined(NDEBUG)
167 #define ALWAYS_INLINE __forceinline
168 #else
169 #define ALWAYS_INLINE inline
170 #endif
171 #endif
172
173
174 /* NEVER_INLINE */
175
176 #ifndef NEVER_INLINE
177 #if COMPILER(GCC)
178 #define NEVER_INLINE __attribute__((__noinline__))
179 #elif COMPILER(RVCT)
180 #define NEVER_INLINE __declspec(noinline)
181 #else
182 #define NEVER_INLINE
183 #endif
184 #endif
185
186
187 /* UNLIKELY */
188
189 #ifndef UNLIKELY
190 #if COMPILER(GCC) || (RVCT_VERSION_AT_LEAST(3, 0, 0, 0) && defined(__GNUC__))
191 #define UNLIKELY(x) __builtin_expect((x), 0)
192 #else
193 #define UNLIKELY(x) (x)
194 #endif
195 #endif
196
197
198 /* LIKELY */
199
200 #ifndef LIKELY
201 #if COMPILER(GCC) || (RVCT_VERSION_AT_LEAST(3, 0, 0, 0) && defined(__GNUC__))
202 #define LIKELY(x) __builtin_expect((x), 1)
203 #else
204 #define LIKELY(x) (x)
205 #endif
206 #endif
207
208
209 /* NO_RETURN */
210
211
212 #ifndef NO_RETURN
213 #if COMPILER(GCC)
214 #define NO_RETURN __attribute((__noreturn__))
215 #elif COMPILER(MSVC) || COMPILER(RVCT)
216 #define NO_RETURN __declspec(noreturn)
217 #else
218 #define NO_RETURN
219 #endif
220 #endif
221
222
223 /* NO_RETURN_WITH_VALUE */
224
225 #ifndef NO_RETURN_WITH_VALUE
226 #if !COMPILER(MSVC)
227 #define NO_RETURN_WITH_VALUE NO_RETURN
228 #else
229 #define NO_RETURN_WITH_VALUE
230 #endif
231 #endif
232
233
234 /* WARN_UNUSED_RETURN */
235
236 #if COMPILER(GCC)
237 #define WARN_UNUSED_RETURN __attribute__ ((warn_unused_result))
238 #else
239 #define WARN_UNUSED_RETURN
240 #endif
241
242 /* OVERRIDE and FINAL */
243
244 #if COMPILER_SUPPORTS(CXX_OVERRIDE_CONTROL)
245 #define OVERRIDE override
246
247 #if COMPILER_QUIRK(FINAL_IS_CALLED_SEALED)
248 #define FINAL sealed
249 #else
250 #define FINAL final
251 #endif
252
253 #else
254 #define OVERRIDE
255 #define FINAL
256 #endif
257
258 /* REFERENCED_FROM_ASM */
259
260 #ifndef REFERENCED_FROM_ASM
261 #if COMPILER(GCC)
262 #define REFERENCED_FROM_ASM __attribute__((used))
263 #else
264 #define REFERENCED_FROM_ASM
265 #endif
266 #endif
267
268 /* OBJC_CLASS */
269
270 #ifndef OBJC_CLASS
271 #ifdef __OBJC__
272 #define OBJC_CLASS @class
273 #else
274 #define OBJC_CLASS class
275 #endif
276 #endif
277
278 /* ABI */
279 #if defined(__ARM_EABI__) || defined(__EABI__)
280 #define WTF_COMPILER_SUPPORTS_EABI 1
281 #endif
282
283 #endif /* WTF_Compiler_h */