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/internal/attr/const.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

47 lines
2.2 KiB
C
Raw Normal View History

sed -i s/RUBY3/RBIMPL/g Devs do not love "3". The only exception is RUBY3_KEYWORDS in parse.y, which seems unrelated to our interests.
2020-05-04 02:52:56 -04:00
#ifndef RBIMPL_ATTR_CONST_H /*-*-C++-*-vi:se ft=cpp:*/
#define RBIMPL_ATTR_CONST_H
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
/**
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.
sed -i s/ruby3/rbimpl/g
2020-05-04 03:27:48 -04:00
* @warning Symbols prefixed with either `RBIMPL` or `rbimpl` are
Merge pull request #2991 from shyouhei/ruby.h Split ruby.h
2020-04-08 00:28:13 -04:00
* 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
sed -i 's/. They/. They/' Truly editorial fix for comments. This works better with Emacs' set-justification-full function. [ci skip]
2021-01-14 01:00:54 -05:00
* extension libraries. They could be written in C++98.
sed -i s/RUBY3/RBIMPL/g Devs do not love "3". The only exception is RUBY3_KEYWORDS in parse.y, which seems unrelated to our interests.
2020-05-04 02:52:56 -04:00
* @brief Defines #RBIMPL_ATTR_CONST.
Merge pull request #2991 from shyouhei/ruby.h Split ruby.h
2020-04-08 00:28:13 -04:00
*/
sed -i 's|ruby/impl|ruby/internal|' To fix build failures.
2020-05-08 05:31:09 -04:00
#include "ruby/internal/compiler_since.h"
#include "ruby/internal/has/attribute.h"
#include "ruby/internal/has/declspec_attribute.h"
Merge pull request #2991 from shyouhei/ruby.h Split ruby.h
2020-04-08 00:28:13 -04:00
/** Wraps (or simulates) `__attribute__((const))` */
sed -i s/RUBY3/RBIMPL/g Devs do not love "3". The only exception is RUBY3_KEYWORDS in parse.y, which seems unrelated to our interests.
2020-05-04 02:52:56 -04:00
#if RBIMPL_HAS_ATTRIBUTE(const)
# define RBIMPL_ATTR_CONST() __attribute__((__const__))
#elif RBIMPL_HAS_DECLSPEC_ATTRIBUTE(noalias)
Merge pull request #2991 from shyouhei/ruby.h Split ruby.h
2020-04-08 00:28:13 -04:00
# /* If a function can be a const, that is also a noalias. */
sed -i s/RUBY3/RBIMPL/g Devs do not love "3". The only exception is RUBY3_KEYWORDS in parse.y, which seems unrelated to our interests.
2020-05-04 02:52:56 -04:00
# define RBIMPL_ATTR_CONST() __declspec(noalias)
#elif RBIMPL_COMPILER_SINCE(SunPro, 5, 10, 0)
# define RBIMPL_ATTR_CONST() _Pragma("no_side_effect")
Merge pull request #2991 from shyouhei/ruby.h Split ruby.h
2020-04-08 00:28:13 -04:00
#else
sed -i s/RUBY3/RBIMPL/g Devs do not love "3". The only exception is RUBY3_KEYWORDS in parse.y, which seems unrelated to our interests.
2020-05-04 02:52:56 -04:00
# define RBIMPL_ATTR_CONST() /* void */
Merge pull request #2991 from shyouhei/ruby.h Split ruby.h
2020-04-08 00:28:13 -04:00
#endif
Replace "iff" with "if and only if" iff means if and only if, but readers without that knowledge might assume this to be a spelling mistake. To me, this seems like exclusionary language that is unnecessary. Simply using "if and only if" instead should suffice.
2021-01-06 12:20:03 -05:00
/** Enables #RBIMPL_ATTR_CONST if and only if. ! #RUBY_DEBUG. */
Fix trivial -Wundef warnings * See [Feature #17752] Co-authored-by: xtkoba (Tee KOBAYASHI) <xtkoba+ruby@gmail.com>
2021-04-29 08:31:05 -04:00
#if !defined(RUBY_DEBUG) || !RUBY_DEBUG
Use RUBY_DEBUG instead of NDEBUG Assertions in header files slows down an interpreter, so they should be turned off by default (simple `make`). To enable them, define a macro `RUBY_DEBUG=1` (e.g. `make cppflags=-DRUBY_DEBUG` or use `#define` at the very beggining of the file. Note that even if `NDEBUG=1` is defined, `RUBY_DEBUG=1` enables all assertions. [Feature #16837] related: https://github.com/ruby/ruby/pull/3120 `assert()` lines in MRI *.c is not disabled even if `RUBY_DEBUG=0` and it can be disabled with `NDEBUG=1`. So please consider to use `RUBY_ASSERT()` if you want to disable them when `RUBY_DEBUG=0`.
2020-05-19 22:38:44 -04:00
# define RBIMPL_ATTR_CONST_UNLESS_DEBUG() RBIMPL_ATTR_CONST()
Merge pull request #2991 from shyouhei/ruby.h Split ruby.h
2020-04-08 00:28:13 -04:00
#else
Use RUBY_DEBUG instead of NDEBUG Assertions in header files slows down an interpreter, so they should be turned off by default (simple `make`). To enable them, define a macro `RUBY_DEBUG=1` (e.g. `make cppflags=-DRUBY_DEBUG` or use `#define` at the very beggining of the file. Note that even if `NDEBUG=1` is defined, `RUBY_DEBUG=1` enables all assertions. [Feature #16837] related: https://github.com/ruby/ruby/pull/3120 `assert()` lines in MRI *.c is not disabled even if `RUBY_DEBUG=0` and it can be disabled with `NDEBUG=1`. So please consider to use `RUBY_ASSERT()` if you want to disable them when `RUBY_DEBUG=0`.
2020-05-19 22:38:44 -04:00
# define RBIMPL_ATTR_CONST_UNLESS_DEBUG() /* void */
Merge pull request #2991 from shyouhei/ruby.h Split ruby.h
2020-04-08 00:28:13 -04:00
#endif
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
sed -i s/RUBY3/RBIMPL/g Devs do not love "3". The only exception is RUBY3_KEYWORDS in parse.y, which seems unrelated to our interests.
2020-05-04 02:52:56 -04:00
#endif /* RBIMPL_ATTR_CONST_H */
Copy permalink