kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity
ruby--ruby/include/ruby/3/warning_push.h

92 lines
4.2 KiB
C
Raw Normal View History

add #include guard hack According to MSVC manual (*1), cl.exe can skip including a header file when that: - contains #pragma once, or - starts with #ifndef, or - starts with #if ! defined. GCC has a similar trick (*2), but it acts more stricter (e. g. there must be _no tokens_ outside of #ifndef...#endif). Sun C lacked #pragma once for a looong time. Oracle Developer Studio 12.5 finally implemented it, but we cannot assume such recent version. This changeset modifies header files so that each of them include strictly one #ifndef...#endif. I believe this is the most portable way to trigger compiler optimizations. [Bug #16770] *1: https://docs.microsoft.com/en-us/cpp/preprocessor/once *2: https://gcc.gnu.org/onlinedocs/cppinternals/Guard-Macros.html
2020-04-10 01:11:40 -04:00
#ifndef RUBY3_WARNING_PUSH_H /*-*-C++-*-vi:se ft=cpp:*/
#define RUBY3_WARNING_PUSH_H
/**
Merge pull request #2991 from shyouhei/ruby.h Split ruby.h
2020-04-08 00:28:13 -04:00
* @file
* @author Ruby developers <ruby-core@ruby-lang.org>
* @copyright This file is a part of the programming language Ruby.
* Permission is hereby granted, to either redistribute and/or
* modify this file, provided that the conditions mentioned in the
* file COPYING are met. Consult the file for details.
* @warning Symbols prefixed with either `RUBY3` or `ruby3` are
* implementation details. Don't take them as canon. They could
* rapidly appear then vanish. The name (path) of this header file
* is also an implementation detail. Do not expect it to persist
* at the place it is now. Developers are free to move it anywhere
* anytime at will.
* @note To ruby-core: remember that this header can be possibly
* recursively included from extension libraries written in C++.
* Do not expect for instance `__VA_ARGS__` is always available.
* We assume C99 for ruby itself but we don't assume languages of
* extension libraries. They could be written in C++98.
* @brief Defines RUBY3_WARNING_PUSH.
* @cond INTERNAL_MACRO
*
* ### Q&A ###
*
* Q: Why all the macros defined in this file are function-like macros?
*
* A: Sigh. This is because of Doxgen. Its `SKIP_FUNCTION_MACROS = YES`
* configuration setting requests us that if we want it to ignore these
* macros, then we have to do two things: (1) let them be defined as
* function-like macros, and (2) place them separately in their own line,
* like below:
*
* ```CXX
* // NG -- foo's type considered something like `unsigned int`.
* RUBY3_WARNING_PUSH
* int foo(void);
* RUBY3_WARNING_POP
*
* // OK -- the macros are ignored by Doxygen.
* RUBY3_WARNING_PUSH()
* int foo(void);
* RUBY3_WARNING_POP()
* ```
*/
#include "ruby/3/compiler_is.h"
include what you use. This reverts commit 443389effc37308ce1a3c3a840082a344fc6af56. This reverts commit d94960f22ec2de3a3855305cb51343806d2b46c7. Inclusion of header files must be explicit. Every file shall directly include what is necessary. https://github.com/include-what-you-use/include-what-you-use says: > When every file includes what it uses, then it is possible to edit any > file and remove unused headers, without fear of accidentally breaking > the upwards dependencies of that file. It also becomes easy to > automatically track and update dependencies in the source code. Though we don't use iwyu itself, the principle quoted above is a good thing that we can agree. Now that include guards were added to every and all of the headers inside of our project this changeset does not increase compile time, at least on my machine.
2020-04-12 02:42:45 -04:00
#include "ruby/3/compiler_since.h"
Merge pull request #2991 from shyouhei/ruby.h Split ruby.h
2020-04-08 00:28:13 -04:00
add #include guard hack According to MSVC manual (*1), cl.exe can skip including a header file when that: - contains #pragma once, or - starts with #ifndef, or - starts with #if ! defined. GCC has a similar trick (*2), but it acts more stricter (e. g. there must be _no tokens_ outside of #ifndef...#endif). Sun C lacked #pragma once for a looong time. Oracle Developer Studio 12.5 finally implemented it, but we cannot assume such recent version. This changeset modifies header files so that each of them include strictly one #ifndef...#endif. I believe this is the most portable way to trigger compiler optimizations. [Bug #16770] *1: https://docs.microsoft.com/en-us/cpp/preprocessor/once *2: https://gcc.gnu.org/onlinedocs/cppinternals/Guard-Macros.html
2020-04-10 01:11:40 -04:00
#if RUBY3_COMPILER_SINCE(MSVC, 12, 0, 0)
Merge pull request #2991 from shyouhei/ruby.h Split ruby.h
2020-04-08 00:28:13 -04:00
# /* Not sure exactly when but it seems VC++ 6.0 is a version with it.*/
# define RUBY3_WARNING_PUSH() __pragma(warning(push))
# define RUBY3_WARNING_POP() __pragma(warning(pop))
# define RUBY3_WARNING_ERROR(flag) __pragma(warning(error: flag))
# define RUBY3_WARNING_IGNORED(flag) __pragma(warning(disable: flag))
#elif RUBY3_COMPILER_SINCE(Intel, 13, 0, 0)
# define RUBY3_WARNING_PUSH() __pragma(warning(push))
# define RUBY3_WARNING_POP() __pragma(warning(pop))
# define RUBY3_WARNING_ERROR(flag) __pragma(warning(error: flag))
# define RUBY3_WARNING_IGNORED(flag) __pragma(warning(disable: flag))
#elif RUBY3_COMPILER_IS(Clang) || RUBY3_COMPILER_IS(Apple)
# /* Not sure exactly when but it seems LLVM 2.6.0 is a version with it. */
# define RUBY3_WARNING_PRAGMA0(x) _Pragma(# x)
# define RUBY3_WARNING_PRAGMA1(x) RUBY3_WARNING_PRAGMA0(clang diagnostic x)
# define RUBY3_WARNING_PRAGMA2(x, y) RUBY3_WARNING_PRAGMA1(x # y)
# define RUBY3_WARNING_PUSH() RUBY3_WARNING_PRAGMA1(push)
# define RUBY3_WARNING_POP() RUBY3_WARNING_PRAGMA1(pop)
# define RUBY3_WARNING_ERROR(flag) RUBY3_WARNING_PRAGMA2(error, flag)
# define RUBY3_WARNING_IGNORED(flag) RUBY3_WARNING_PRAGMA2(ignored, flag)
#elif RUBY3_COMPILER_SINCE(GCC, 4, 6, 0)
# /* https://gcc.gnu.org/onlinedocs/gcc-4.6.0/gcc/Diagnostic-Pragmas.html */
# define RUBY3_WARNING_PRAGMA0(x) _Pragma(# x)
# define RUBY3_WARNING_PRAGMA1(x) RUBY3_WARNING_PRAGMA0(GCC diagnostic x)
# define RUBY3_WARNING_PRAGMA2(x, y) RUBY3_WARNING_PRAGMA1(x # y)
# define RUBY3_WARNING_PUSH() RUBY3_WARNING_PRAGMA1(push)
# define RUBY3_WARNING_POP() RUBY3_WARNING_PRAGMA1(pop)
# define RUBY3_WARNING_ERROR(flag) RUBY3_WARNING_PRAGMA2(error, flag)
# define RUBY3_WARNING_IGNORED(flag) RUBY3_WARNING_PRAGMA2(ignored, flag)
#else
# /* :FIXME: improve here */
# define RUBY3_WARNING_PUSH() /* void */
# define RUBY3_WARNING_POP() /* void */
# define RUBY3_WARNING_ERROR(flag) /* void */
# define RUBY3_WARNING_IGNORED(flag) /* void */
#endif /* _MSC_VER */
/** @endcond */
add #include guard hack According to MSVC manual (*1), cl.exe can skip including a header file when that: - contains #pragma once, or - starts with #ifndef, or - starts with #if ! defined. GCC has a similar trick (*2), but it acts more stricter (e. g. there must be _no tokens_ outside of #ifndef...#endif). Sun C lacked #pragma once for a looong time. Oracle Developer Studio 12.5 finally implemented it, but we cannot assume such recent version. This changeset modifies header files so that each of them include strictly one #ifndef...#endif. I believe this is the most portable way to trigger compiler optimizations. [Bug #16770] *1: https://docs.microsoft.com/en-us/cpp/preprocessor/once *2: https://gcc.gnu.org/onlinedocs/cppinternals/Guard-Macros.html
2020-04-10 01:11:40 -04:00
#endif /* RUBY3_WARNING_PUSH_H */
Copy permalink