-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Allow &&
, ||
, and !
in cfg
#3796
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jhpratt
wants to merge
4
commits into
rust-lang:master
Choose a base branch
from
jhpratt:cfg-logical-ops
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
- Feature Name: `cfg_logical_ops` | ||
- Start Date: 2025-03-30 | ||
- RFC PR: [rust-lang/rfcs#0000](https://github.com/rust-lang/rfcs/pull/0000) | ||
- Rust Issue: [rust-lang/rust#0000](https://github.com/rust-lang/rust/issues/0000) | ||
|
||
# Summary | ||
[summary]: #summary | ||
|
||
`#[cfg]`, `#[cfg_attr]`, and `cfg!()` can use `&&`, `||`, and `!` for `all`, `any`, and `not`, | ||
respectively. | ||
|
||
# Motivation | ||
[motivation]: #motivation | ||
|
||
While there are no technical restrictions to using logical operators, this was not always the case. | ||
In Rust 1.0, attributes could not contain arbitrary tokens. This restriction was lifted in Rust | ||
1.34, but the `cfg` syntax was not updated to take advantage of this. By letting developers use | ||
logical operators, we are _lessening_ the burden of having to remember the `cfg` syntax. | ||
|
||
# Explanation | ||
jhpratt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[explanation]: #explanation | ||
[cfg-syntax]: https://doc.rust-lang.org/reference/conditional-compilation.html#r-cfg.syntax | ||
|
||
`#[cfg(foo && bar)]` enables the annotated code if and only if both `foo` **and** `bar` are enabled. | ||
Similarly, `#[cfg(foo || bar)]` enables the annotated code if and only if either `foo` **or** `bar` | ||
is enabled. Finally, `#[cfg(!foo)]` enables the annotated code if and only if `foo` is **not** | ||
enabled. `#[cfg_attr]` and `cfg!()` behave the same way. Precedence is the same as in expressions. | ||
|
||
In terms of formal syntax, the [`[cfg.syntax]`][cfg-syntax] is changed to the following: | ||
|
||
> **<sup>Syntax</sup>**\ | ||
> _ConfigurationPredicate_ :\ | ||
> _ConfigurationOption_\ | ||
> | _ConfigurationAll_\ | ||
> | _ConfigurationAny_\ | ||
> | _ConfigurationNot_\ | ||
> | _ConfigurationAnd_\ | ||
> | _ConfigurationOr_\ | ||
> | _ConfigurationNotOption_\ | ||
> | `(` _ConfigurationPredicate_ `)` | ||
> | ||
> _ConfigurationOption_ :\ | ||
> [IDENTIFIER] (`=` ([STRING_LITERAL] | [RAW_STRING_LITERAL]))<sup>?</sup> | ||
> | ||
> _ConfigurationAll_\ | ||
> `all` `(` _ConfigurationPredicateList_<sup>?</sup> `)` | ||
> | ||
> _ConfigurationAny_\ | ||
> `any` `(` _ConfigurationPredicateList_<sup>?</sup> `)` | ||
> | ||
> _ConfigurationNot_\ | ||
> (`not` | `!`) `(` _ConfigurationPredicate_ `)` | ||
> | ||
> _ConfigurationAnd_\ | ||
> _ConfigurationPredicate_ `&&` _ConfigurationPredicate_ | ||
> | ||
> _ConfigurationOr_\ | ||
> _ConfigurationPredicate_ `||` _ConfigurationPredicate_ | ||
jhpratt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
> | ||
> _ConfigurationNotOption_\ | ||
> `!` _ConfigurationOption_ | ||
jhpratt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
> | ||
> _ConfigurationPredicateList_\ | ||
> _ConfigurationPredicate_ (`,` _ConfigurationPredicate_)<sup>\*</sup> `,`<sup>?</sup> | ||
|
||
# Drawbacks | ||
[drawbacks]: #drawbacks | ||
|
||
- Two ways to express the same thing. This can be somewhat mitigated by a lint for the old syntax. | ||
|
||
# Rationale and alternatives | ||
[rationale-and-alternatives]: #rationale-and-alternatives | ||
|
||
- The current syntax is verbose and a relic of the past when attributes could not contain arbitrary | ||
tokens. | ||
- Using existing, widely-understood operators makes the syntax more familiar. | ||
|
||
# Prior art | ||
[prior-art]: #prior-art | ||
|
||
The `efg` crate is nearly identical to this proposal, the sole difference being not requiring `=` | ||
for key-value pairs. | ||
|
||
# Unresolved questions | ||
[unresolved-questions]: #unresolved-questions | ||
|
||
None so far. | ||
|
||
# Future possibilities | ||
[future-possibilities]: #future-possibilities | ||
|
||
- Pattern-like syntax such as `#[cfg(feature = "foo" | "bar")]` could be allowed as a shorthand for | ||
`#[cfg(feature = "foo" || feature = "bar")]`. This would be particularly useful for | ||
platform-specific code (e.g. `#[cfg(target_os = "linux" | "windows")]`). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.