(b76ad15ed0da636161de0243c547ee1e6fc95681)
Various attribute-related macros. More...
#include "ruby/internal/config.h"#include "ruby/internal/attr/alloc_size.h"#include "ruby/internal/attr/cold.h"#include "ruby/internal/attr/const.h"#include "ruby/internal/attr/deprecated.h"#include "ruby/internal/attr/error.h"#include "ruby/internal/attr/forceinline.h"#include "ruby/internal/attr/format.h"#include "ruby/internal/attr/maybe_unused.h"#include "ruby/internal/attr/noinline.h"#include "ruby/internal/attr/nonnull.h"#include "ruby/internal/attr/noreturn.h"#include "ruby/internal/attr/pure.h"#include "ruby/internal/attr/restrict.h"#include "ruby/internal/attr/returns_nonnull.h"#include "ruby/internal/attr/warning.h"#include "ruby/internal/has/attribute.h"
Go to the source code of this file.
Detailed Description
Various attribute-related macros.
- 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
RBIMPLorrbimplare 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.
Q&A
- Q: Why are the macros defined in this header file so inconsistent in style?
- A: Don't know. Don't blame me. Backward compatibility is the key here. I'm just preserving what they have been.
Definition in file attributes.h.
Macro Definition Documentation
◆ ALWAYS_INLINE
| #define ALWAYS_INLINE | ( | x | ) | RBIMPL_ATTR_FORCEINLINE() x |
Definition at line 86 of file attributes.h.
◆ COLDFUNC
| #define COLDFUNC RBIMPL_ATTR_COLD() |
Definition at line 106 of file attributes.h.
◆ CONSTFUNC
| #define CONSTFUNC | ( | x | ) | RBIMPL_ATTR_CONST() x |
Definition at line 51 of file attributes.h.
◆ DEPRECATED
| #define DEPRECATED | ( | x | ) | RBIMPL_ATTR_DEPRECATED(("")) x |
Definition at line 57 of file attributes.h.
◆ DEPRECATED_BY
| #define DEPRECATED_BY | ( | n, | |
| x | |||
| ) | RBIMPL_ATTR_DEPRECATED(("by: " # n)) x |
Definition at line 60 of file attributes.h.
◆ DEPRECATED_TYPE
| #define DEPRECATED_TYPE | ( | mesg, | |
| decl | |||
| ) |
Definition at line 64 of file attributes.h.
◆ ERRORFUNC
| #define ERRORFUNC | ( | mesg, | |
| x | |||
| ) | RBIMPL_ATTR_ERROR(mesg) x |
Definition at line 90 of file attributes.h.
◆ FUNC_MINIMIZED
| #define FUNC_MINIMIZED | ( | x | ) | x |
Definition at line 122 of file attributes.h.
◆ FUNC_UNOPTIMIZED
| #define FUNC_UNOPTIMIZED | ( | x | ) | x |
Definition at line 126 of file attributes.h.
◆ HAVE_ATTRIBUTE_ERRORFUNC
| #define HAVE_ATTRIBUTE_ERRORFUNC 1 |
Definition at line 92 of file attributes.h.
◆ HAVE_ATTRIBUTE_WARNINGFUNC
| #define HAVE_ATTRIBUTE_WARNINGFUNC 1 |
Definition at line 98 of file attributes.h.
◆ NOINLINE
| #define NOINLINE | ( | x | ) | RBIMPL_ATTR_NOINLINE() x |
Definition at line 82 of file attributes.h.
◆ NORETURN
| #define NORETURN | ( | x | ) | RBIMPL_ATTR_NORETURN() x |
Definition at line 148 of file attributes.h.
◆ NORETURN_STYLE_NEW
| #define NORETURN_STYLE_NEW |
Definition at line 149 of file attributes.h.
◆ PACKED_STRUCT
| #define PACKED_STRUCT | ( | x | ) | x |
Definition at line 152 of file attributes.h.
◆ PACKED_STRUCT_UNALIGNED
| #define PACKED_STRUCT_UNALIGNED | ( | x | ) | x |
Definition at line 159 of file attributes.h.
◆ PRINTF_ARGS
| #define PRINTF_ARGS | ( | decl, | |
| string_index, | |||
| first_to_check | |||
| ) |
Definition at line 108 of file attributes.h.
◆ PUREFUNC
| #define PUREFUNC | ( | x | ) | RBIMPL_ATTR_PURE() x |
Definition at line 54 of file attributes.h.
◆ RB_UNUSED_VAR
| #define RB_UNUSED_VAR | ( | x | ) | x RBIMPL_ATTR_MAYBE_UNUSED() |
Definition at line 164 of file attributes.h.
◆ RUBY_ALIAS_FUNCTION
| #define RUBY_ALIAS_FUNCTION | ( | prot, | |
| name, | |||
| args | |||
| ) | RUBY_ALIAS_FUNCTION_TYPE(VALUE, prot, name, args) |
Definition at line 140 of file attributes.h.
◆ RUBY_ALIAS_FUNCTION_TYPE
| #define RUBY_ALIAS_FUNCTION_TYPE | ( | type, | |
| prot, | |||
| name, | |||
| args | |||
| ) | FUNC_MINIMIZED(type prot) {return (type)name args;} |
Definition at line 130 of file attributes.h.
◆ RUBY_ALIAS_FUNCTION_VOID
| #define RUBY_ALIAS_FUNCTION_VOID | ( | prot, | |
| name, | |||
| args | |||
| ) | FUNC_MINIMIZED(void prot) {name args;} |
Definition at line 135 of file attributes.h.
◆ RUBY_ATTR_ALLOC_SIZE
| #define RUBY_ATTR_ALLOC_SIZE RBIMPL_ATTR_ALLOC_SIZE |
Definition at line 113 of file attributes.h.
◆ RUBY_ATTR_MALLOC
| #define RUBY_ATTR_MALLOC RBIMPL_ATTR_RESTRICT() |
Definition at line 116 of file attributes.h.
◆ RUBY_ATTR_RETURNS_NONNULL
| #define RUBY_ATTR_RETURNS_NONNULL RBIMPL_ATTR_RETURNS_NONNULL() |
Definition at line 119 of file attributes.h.
◆ RUBY_CXX_DEPRECATED
| #define RUBY_CXX_DEPRECATED | ( | mseg | ) | RBIMPL_ATTR_DEPRECATED((mseg)) |
Definition at line 79 of file attributes.h.
◆ RUBY_FUNC_NONNULL
| #define RUBY_FUNC_NONNULL | ( | n, | |
| x | |||
| ) | RBIMPL_ATTR_NONNULL(n) x |
Definition at line 145 of file attributes.h.
◆ WARNINGFUNC
| #define WARNINGFUNC | ( | mesg, | |
| x | |||
| ) | RBIMPL_ATTR_WARNING(mesg) x |
Definition at line 96 of file attributes.h.
