Introduces implementation-defined attributes for types, objects, expressions, etc.
Contents |
[[attr ]][[attr1,attr2,attr3(args)]][[attribute-prefix::attr (args)]]Formally, the syntax is
[[attribute-list]] | (since C23) | ||||||||
whereattribute-list is a comma-separated sequence of zero or moreattribute-token s
| standard-attribute | (1) | ||||||||
attribute-prefix::identifier | (2) | ||||||||
standard-attribute(argument-list (optional)) | (3) | ||||||||
attribute-prefix::identifier(argument-list (optional)) | (4) | ||||||||
whereattribute-prefix is anidentifier andargument-list is a sequence of tokens where parentheses, brackets and braces are balanced (balanced-token-sequence).
Attributes provide the unified standard syntax for implementation-defined language extensions, such as the GNU and IBM language extensions__attribute__((...)), Microsoft extension__declspec(), etc.
An attribute can be used almost everywhere in the C program, and can be applied to almost everything: to types, to variables, to functions, to names, to code blocks, to entire translation units, although each particular attribute is only valid where it is permitted by the implementation:[[expect_true]] could be an attribute that can only be used with anif, and not with a class declaration.[[omp::parallel()]] could be an attribute that applies to a code block or to afor loop, but not to the typeint, etc. (note these two attributes are fictional examples, see below for the standard and some non-standard attributes)
In declarations, attributes may appear both before the whole declaration and directly after the name of the entity that is declared, in which case they are combined. In most other situations, attributes apply to the directly preceding entity.
Two consecutive left square bracket tokens ([[) may only appear when introducing an attribute-specifier or inside an attribute argument.
Besides the standard attributes listed below, implementations may support arbitrary non-standard attributes with implementation-defined behavior. All attributes unknown to an implementation are ignored without causing an error.
Everystandard-attribute is reserved for standardization. That is, every non-standard attribute is prefixed by aattribute-prefix provided by the implementation, e.g.[[gnu::may_alias]] and[[clang::no_sanitize]].
Only the following attributes are defined by the C standard. Every standard attribute whose name is of formattr can be also spelled as__attr__ and its meaning is not changed.
[[deprecated]](C23)[[deprecated("reason")]](C23) | indicates that the use of the name or entity declared with this attribute is allowed, but discouraged for somereason (attribute specifier)[edit] |
[[fallthrough]](C23) | indicates that the fall through from the previous case label is intentional and should not be diagnosed by a compiler that warns on fall-through (attribute specifier)[edit] |
| encourages the compiler to issue a warning if the return value is discarded (attribute specifier)[edit] | |
[[maybe_unused]](C23) | suppresses compiler warnings on unused entities, if any (attribute specifier)[edit] |
| indicates that the function does not return (attribute specifier)[edit] | |
[[unsequenced]](C23) | indicates that a function is stateless, effectless, idempotent and independent (attribute specifier)[edit] |
[[reproducible]](C23) | indicates that a function is effectless and idempotent (attribute specifier)[edit] |
__has_c_attribute(attribute-token) | |||||||||
Checks for the presence of an attribute token named byattribute-token.
For standard attributes, it will expand to the year and month in which the attribute was added to the working draft (see table below), the presence of vendor-specific attributes is determined by a non-zero integer constant.
__has_c_attribute can be expanded in the expression of#if and#elif.It is treated as a defined macro by#ifdef,#ifndef anddefined but cannot be used anywhere else.
| attribute-token | Attribute | Value | Standard |
|---|---|---|---|
deprecated | [[deprecated]] | 201904L | (C23) |
fallthrough | [[fallthrough]] | 201904L | (C23) |
maybe_unused | [[maybe_unused]] | 201904L | (C23) |
nodiscard | [[nodiscard]] | 202003L | (C23) |
noreturn_Noreturn | [[noreturn]][[_Noreturn]] | 202202L | (C23) |
unsequenced | [[unsequenced]] | 202207L | (C23) |
reproducible | [[reproducible]] | 202207L | (C23) |
[[gnu::hot]][[gnu::const]][[nodiscard]]int f(void);// declare f with three attributes [[gnu::const, gnu::hot, nodiscard]]int f(void);// the same as above, but uses a single attr// specifier that contains three attributes int f(void){return0;} int main(void){}
C++ documentation forAttribute specifier sequence |
| 1. | Attributes in GCC |
| 2. | Attributes in Clang |
