REGRESSION (r149184): Build errors in RefPtr.h when building with Clang, C++98 standard
[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 #define CLANG_PRAGMA(PRAGMA) _Pragma(PRAGMA)
45
46 /* Specific compiler features */
47 #define WTF_COMPILER_SUPPORTS_CXX_VARIADIC_TEMPLATES __has_feature(cxx_variadic_templates)
48
49 /* There is a bug in clang that comes with Xcode 4.2 where AtomicStrings can't be implicitly converted to Strings
50    in the presence of move constructors and/or move assignment operators. This bug has been fixed in Xcode 4.3 clang, so we
51    check for both cxx_rvalue_references as well as the unrelated cxx_nonstatic_member_init feature which we know was added in 4.3 */
52 #define WTF_COMPILER_SUPPORTS_CXX_RVALUE_REFERENCES __has_feature(cxx_rvalue_references) && __has_feature(cxx_nonstatic_member_init)
53
54 #define WTF_COMPILER_SUPPORTS_CXX_DELETED_FUNCTIONS __has_feature(cxx_deleted_functions)
55 #define WTF_COMPILER_SUPPORTS_CXX_NULLPTR __has_feature(cxx_nullptr)
56 #define WTF_COMPILER_SUPPORTS_CXX_EXPLICIT_CONVERSIONS __has_feature(cxx_explicit_conversions)
57 #define WTF_COMPILER_SUPPORTS_BLOCKS __has_feature(blocks)
58 #define WTF_COMPILER_SUPPORTS_C_STATIC_ASSERT __has_feature(c_static_assert)
59 #define WTF_COMPILER_SUPPORTS_CXX_STATIC_ASSERT __has_feature(cxx_static_assert)
60 #define WTF_COMPILER_SUPPORTS_CXX_OVERRIDE_CONTROL __has_feature(cxx_override_control)
61 #define WTF_COMPILER_SUPPORTS_HAS_TRIVIAL_DESTRUCTOR __has_feature(has_trivial_destructor)
62 #define WTF_COMPILER_SUPPORTS_CXX_STRONG_ENUMS __has_feature(cxx_strong_enums)
63 #define WTF_COMPILER_SUPPORTS_CXX_REFERENCE_QUALIFIED_FUNCTIONS __has_feature(cxx_reference_qualified_functions)
64 #endif
65
66 #ifndef CLANG_PRAGMA
67 #define CLANG_PRAGMA(PRAGMA)
68 #endif
69
70 /* COMPILER(MSVC) - Microsoft Visual C++ */
71 /* COMPILER(MSVC9_OR_LOWER) - Microsoft Visual C++ 2008 or lower*/
72 #if defined(_MSC_VER)
73 #define WTF_COMPILER_MSVC 1
74 #if _MSC_VER < 1600
75 #define WTF_COMPILER_MSVC9_OR_LOWER 1
76 #endif
77
78 /* Specific compiler features */
79 #if !COMPILER(CLANG) && _MSC_VER >= 1600
80 #define WTF_COMPILER_SUPPORTS_CXX_NULLPTR 1
81 #endif
82
83 #if !COMPILER(CLANG)
84 #define WTF_COMPILER_SUPPORTS_CXX_OVERRIDE_CONTROL 1
85 #define WTF_COMPILER_QUIRK_FINAL_IS_CALLED_SEALED 1
86 #endif
87
88 /* Check for VS2010 or newer */
89 #if _MSC_VER >= 1600
90 #define WTF_COMPILER_SUPPORTS_CXX_RVALUE_REFERENCES 1
91 #define WTF_COMPILER_SUPPORTS_CXX_STATIC_ASSERT 1
92 #endif
93
94 #endif /* defined(_MSC_VER) */
95
96 /* COMPILER(RVCT) - ARM RealView Compilation Tools */
97 #if defined(__CC_ARM) || defined(__ARMCC__)
98 #define WTF_COMPILER_RVCT 1
99 #define RVCT_VERSION_AT_LEAST(major, minor, patch, build) (__ARMCC_VERSION >= (major * 100000 + minor * 10000 + patch * 1000 + build))
100 #else
101 /* Define this for !RVCT compilers, just so we can write things like RVCT_VERSION_AT_LEAST(3, 0, 0, 0). */
102 #define RVCT_VERSION_AT_LEAST(major, minor, patch, build) 0
103 #endif
104
105 /* COMPILER(GCCE) - GNU Compiler Collection for Embedded */
106 #if defined(__GCCE__)
107 #define WTF_COMPILER_GCCE 1
108 #define GCCE_VERSION (__GCCE__ * 10000 + __GCCE_MINOR__ * 100 + __GCCE_PATCHLEVEL__)
109 #define GCCE_VERSION_AT_LEAST(major, minor, patch) (GCCE_VERSION >= (major * 10000 + minor * 100 + patch))
110 #endif
111
112 /* COMPILER(GCC) - GNU Compiler Collection */
113 /* --gnu option of the RVCT compiler also defines __GNUC__ */
114 #if defined(__GNUC__) && !COMPILER(RVCT)
115 #define WTF_COMPILER_GCC 1
116 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
117 #define GCC_VERSION_AT_LEAST(major, minor, patch) (GCC_VERSION >= (major * 10000 + minor * 100 + patch))
118 #else
119 /* Define this for !GCC compilers, just so we can write things like GCC_VERSION_AT_LEAST(4, 1, 0). */
120 #define GCC_VERSION_AT_LEAST(major, minor, patch) 0
121 #endif
122
123 /* Specific compiler features */
124 #if COMPILER(GCC) && !COMPILER(CLANG)
125 #if GCC_VERSION_AT_LEAST(4, 8, 0)
126 #pragma GCC diagnostic ignored "-Wunused-local-typedefs"
127 #endif
128 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
129 /* C11 support */
130 #define WTF_COMPILER_SUPPORTS_C_STATIC_ASSERT 1
131 #endif
132 #if defined(__GXX_EXPERIMENTAL_CXX0X__) || (defined(__cplusplus) && __cplusplus >= 201103L)
133 /* C++11 support */
134 #if GCC_VERSION_AT_LEAST(4, 3, 0)
135 #define WTF_COMPILER_SUPPORTS_CXX_RVALUE_REFERENCES 1
136 #define WTF_COMPILER_SUPPORTS_CXX_STATIC_ASSERT 1
137 #define WTF_COMPILER_SUPPORTS_CXX_VARIADIC_TEMPLATES 1
138 #endif
139 #if GCC_VERSION_AT_LEAST(4, 4, 0)
140 #define WTF_COMPILER_SUPPORTS_CXX_DELETED_FUNCTIONS 1
141 #endif
142 #if GCC_VERSION_AT_LEAST(4, 5, 0)
143 #define WTF_COMPILER_SUPPORTS_CXX_EXPLICIT_CONVERSIONS 1
144 #endif
145 #if GCC_VERSION_AT_LEAST(4, 6, 0)
146 #define WTF_COMPILER_SUPPORTS_CXX_NULLPTR 1
147 /* Strong enums should work from gcc 4.4, but doesn't seem to support some operators */
148 #define WTF_COMPILER_SUPPORTS_CXX_STRONG_ENUMS 1
149 #endif
150 #if GCC_VERSION_AT_LEAST(4, 7, 0)
151 #define WTF_COMPILER_SUPPORTS_CXX_OVERRIDE_CONTROL 1
152 #endif
153 #endif /* defined(__GXX_EXPERIMENTAL_CXX0X__) || (defined(__cplusplus) && __cplusplus >= 201103L) */
154 #endif /* COMPILER(GCC) */
155
156 /* COMPILER(MINGW) - MinGW GCC */
157 /* COMPILER(MINGW64) - mingw-w64 GCC - only used as additional check to exclude mingw.org specific functions */
158 #if defined(__MINGW32__)
159 #define WTF_COMPILER_MINGW 1
160 #include <_mingw.h> /* private MinGW header */
161     #if defined(__MINGW64_VERSION_MAJOR) /* best way to check for mingw-w64 vs mingw.org */
162         #define WTF_COMPILER_MINGW64 1
163     #endif /* __MINGW64_VERSION_MAJOR */
164 #endif /* __MINGW32__ */
165
166 /* COMPILER(INTEL) - Intel C++ Compiler */
167 #if defined(__INTEL_COMPILER)
168 #define WTF_COMPILER_INTEL 1
169 #endif
170
171 /* COMPILER(SUNCC) */
172 #if defined(__SUNPRO_CC) || defined(__SUNPRO_C)
173 #define WTF_COMPILER_SUNCC 1
174 #endif
175
176 /* ABI */
177 #if defined(__ARM_EABI__) || defined(__EABI__)
178 #define WTF_COMPILER_SUPPORTS_EABI 1
179 #endif
180
181 /* ==== Compiler features ==== */
182
183 /* ALWAYS_INLINE */
184
185 #ifndef ALWAYS_INLINE
186 #if COMPILER(GCC) && defined(NDEBUG) && !COMPILER(MINGW)
187 #define ALWAYS_INLINE inline __attribute__((__always_inline__))
188 #elif (COMPILER(MSVC) || COMPILER(RVCT)) && defined(NDEBUG)
189 #define ALWAYS_INLINE __forceinline
190 #else
191 #define ALWAYS_INLINE inline
192 #endif
193 #endif
194
195
196 /* NEVER_INLINE */
197
198 #ifndef NEVER_INLINE
199 #if COMPILER(GCC)
200 #define NEVER_INLINE __attribute__((__noinline__))
201 #elif COMPILER(RVCT)
202 #define NEVER_INLINE __declspec(noinline)
203 #else
204 #define NEVER_INLINE
205 #endif
206 #endif
207
208
209 /* UNLIKELY */
210
211 #ifndef UNLIKELY
212 #if COMPILER(GCC) || (COMPILER(RVCT) && defined(__GNUC__))
213 #define UNLIKELY(x) __builtin_expect((x), 0)
214 #else
215 #define UNLIKELY(x) (x)
216 #endif
217 #endif
218
219
220 /* LIKELY */
221
222 #ifndef LIKELY
223 #if COMPILER(GCC) || (COMPILER(RVCT) && defined(__GNUC__))
224 #define LIKELY(x) __builtin_expect((x), 1)
225 #else
226 #define LIKELY(x) (x)
227 #endif
228 #endif
229
230
231 /* NO_RETURN */
232
233
234 #ifndef NO_RETURN
235 #if COMPILER(GCC)
236 #define NO_RETURN __attribute((__noreturn__))
237 #elif COMPILER(MSVC) || COMPILER(RVCT)
238 #define NO_RETURN __declspec(noreturn)
239 #else
240 #define NO_RETURN
241 #endif
242 #endif
243
244
245 /* NO_RETURN_WITH_VALUE */
246
247 #ifndef NO_RETURN_WITH_VALUE
248 #if !COMPILER(MSVC)
249 #define NO_RETURN_WITH_VALUE NO_RETURN
250 #else
251 #define NO_RETURN_WITH_VALUE
252 #endif
253 #endif
254
255
256 /* WARN_UNUSED_RETURN */
257
258 #if COMPILER(GCC)
259 #define WARN_UNUSED_RETURN __attribute__ ((warn_unused_result))
260 #else
261 #define WARN_UNUSED_RETURN
262 #endif
263
264 /* OVERRIDE and FINAL */
265
266 #if COMPILER_SUPPORTS(CXX_OVERRIDE_CONTROL)
267 #define OVERRIDE override
268
269 #if COMPILER_QUIRK(FINAL_IS_CALLED_SEALED)
270 #define FINAL sealed
271 #else
272 #define FINAL final
273 #endif
274
275 #else
276 #define OVERRIDE
277 #define FINAL
278 #endif
279
280 #if COMPILER_SUPPORTS(CXX_DELETED_FUNCTIONS)
281 #define WTF_DELETED_FUNCTION = delete
282 #else
283 #define WTF_DELETED_FUNCTION
284 #endif
285
286 /* REFERENCED_FROM_ASM */
287
288 #ifndef REFERENCED_FROM_ASM
289 #if COMPILER(GCC)
290 #define REFERENCED_FROM_ASM __attribute__((used))
291 #else
292 #define REFERENCED_FROM_ASM
293 #endif
294 #endif
295
296 /* OBJC_CLASS */
297
298 #ifndef OBJC_CLASS
299 #ifdef __OBJC__
300 #define OBJC_CLASS @class
301 #else
302 #define OBJC_CLASS class
303 #endif
304 #endif
305
306 /* UNUSED_PARAM */
307
308 #if COMPILER(INTEL) && !(defined(WIN32) || defined(_WIN32)) || COMPILER(RVCT)
309 template<typename T>
310 inline void unusedParam(T& x) { (void)x; }
311 #define UNUSED_PARAM(variable) unusedParam(variable)
312 #elif COMPILER(MSVC)
313 #define UNUSED_PARAM(variable) (void)&variable
314 #else
315 #define UNUSED_PARAM(variable) (void)variable
316 #endif
317
318 /* UNUSED_LABEL */
319
320 /* This is to keep the compiler from complaining when for local labels are
321  declared but not referenced. For example, this can happen with code that
322  works with auto-generated code.
323  */
324 #if COMPILER(MSVC)
325 #define UNUSED_LABEL(label) if (false) goto label
326 #else
327 #define UNUSED_LABEL(label) UNUSED_PARAM(&& label)
328 #endif
329
330
331
332 #endif /* WTF_Compiler_h */