Ben Murdoch | b8a8cc1 | 2014-11-26 15:28:44 +0000 | [diff] [blame] | 1 | // Copyright 2014 the V8 project authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef V8_BASE_COMPILER_SPECIFIC_H_ |
| 6 | #define V8_BASE_COMPILER_SPECIFIC_H_ |
| 7 | |
| 8 | #include "include/v8config.h" |
| 9 | |
Emily Bernier | d0a1eb7 | 2015-03-24 16:35:39 -0400 | [diff] [blame] | 10 | // Annotate a typedef or function indicating it's ok if it's not used. |
Ben Murdoch | b8a8cc1 | 2014-11-26 15:28:44 +0000 | [diff] [blame] | 11 | // Use like: |
Emily Bernier | d0a1eb7 | 2015-03-24 16:35:39 -0400 | [diff] [blame] | 12 | // typedef Foo Bar ALLOW_UNUSED_TYPE; |
Ben Murdoch | b8a8cc1 | 2014-11-26 15:28:44 +0000 | [diff] [blame] | 13 | #if V8_HAS_ATTRIBUTE_UNUSED |
Emily Bernier | d0a1eb7 | 2015-03-24 16:35:39 -0400 | [diff] [blame] | 14 | #define ALLOW_UNUSED_TYPE __attribute__((unused)) |
Ben Murdoch | b8a8cc1 | 2014-11-26 15:28:44 +0000 | [diff] [blame] | 15 | #else |
Emily Bernier | d0a1eb7 | 2015-03-24 16:35:39 -0400 | [diff] [blame] | 16 | #define ALLOW_UNUSED_TYPE |
Ben Murdoch | b8a8cc1 | 2014-11-26 15:28:44 +0000 | [diff] [blame] | 17 | #endif |
| 18 | |
| 19 | |
Ben Murdoch | b8a8cc1 | 2014-11-26 15:28:44 +0000 | [diff] [blame] | 20 | // Annotate a function indicating the caller must examine the return value. |
| 21 | // Use like: |
| 22 | // int foo() WARN_UNUSED_RESULT; |
| 23 | #if V8_HAS_ATTRIBUTE_WARN_UNUSED_RESULT |
| 24 | #define WARN_UNUSED_RESULT __attribute__((warn_unused_result)) |
| 25 | #else |
| 26 | #define WARN_UNUSED_RESULT /* NOT SUPPORTED */ |
| 27 | #endif |
| 28 | |
Ben Murdoch | c561043 | 2016-08-08 18:44:38 +0100 | [diff] [blame] | 29 | // Tell the compiler a function is using a printf-style format string. |
| 30 | // |format_param| is the one-based index of the format string parameter; |
| 31 | // |dots_param| is the one-based index of the "..." parameter. |
| 32 | // For v*printf functions (which take a va_list), pass 0 for dots_param. |
| 33 | // (This is undocumented but matches what the system C headers do.) |
| 34 | #if defined(__GNUC__) |
| 35 | #define PRINTF_FORMAT(format_param, dots_param) \ |
| 36 | __attribute__((format(printf, format_param, dots_param))) |
| 37 | #else |
| 38 | #define PRINTF_FORMAT(format_param, dots_param) |
| 39 | #endif |
Ben Murdoch | 4a90d5f | 2016-03-22 12:00:34 +0000 | [diff] [blame] | 40 | |
| 41 | // The C++ standard requires that static const members have an out-of-class |
| 42 | // definition (in a single compilation unit), but MSVC chokes on this (when |
| 43 | // language extensions, which are required, are enabled). (You're only likely to |
| 44 | // notice the need for a definition if you take the address of the member or, |
| 45 | // more commonly, pass it to a function that takes it as a reference argument -- |
| 46 | // probably an STL function.) This macro makes MSVC do the right thing. See |
| 47 | // http://msdn.microsoft.com/en-us/library/34h23df8(v=vs.100).aspx for more |
| 48 | // information. Use like: |
| 49 | // |
| 50 | // In .h file: |
| 51 | // struct Foo { |
| 52 | // static const int kBar = 5; |
| 53 | // }; |
| 54 | // |
| 55 | // In .cc file: |
| 56 | // STATIC_CONST_MEMBER_DEFINITION const int Foo::kBar; |
| 57 | #if V8_HAS_DECLSPEC_SELECTANY |
| 58 | #define STATIC_CONST_MEMBER_DEFINITION __declspec(selectany) |
| 59 | #else |
| 60 | #define STATIC_CONST_MEMBER_DEFINITION |
| 61 | #endif |
| 62 | |
Ben Murdoch | b8a8cc1 | 2014-11-26 15:28:44 +0000 | [diff] [blame] | 63 | #endif // V8_BASE_COMPILER_SPECIFIC_H_ |