Skip to content

Commit 3cd267c

Browse files
compiler-errorscompiler-errors
committed
Deny gen keyword in edition_2024_compat lints
1 parent ff24ef9 commit 3cd267c

15 files changed

+156
-35
lines changed

‎compiler/rustc_lint/src/builtin.rs

+71-29
Original file line numberDiff line numberDiff line change
@@ -1775,7 +1775,7 @@ declare_lint! {
17751775
/// ### Example
17761776
///
17771777
/// ```rust,edition2015,compile_fail
1778-
/// #![deny(keyword_idents)]
1778+
/// #![deny(keyword_idents_2018)]
17791779
/// // edition 2015
17801780
/// fn dyn() {}
17811781
/// ```
@@ -1804,7 +1804,7 @@ declare_lint! {
18041804
/// [editions]: https://doc.rust-lang.org/edition-guide/
18051805
/// [raw identifier]: https://doc.rust-lang.org/reference/identifiers.html
18061806
/// [`cargo fix`]: https://doc.rust-lang.org/cargo/commands/cargo-fix.html
1807-
pub KEYWORD_IDENTS,
1807+
pub KEYWORD_IDENTS_2018,
18081808
Allow,
18091809
"detects edition keywords being used as an identifier",
18101810
@future_incompatible = FutureIncompatibleInfo {
@@ -1813,9 +1813,54 @@ declare_lint! {
18131813
};
18141814
}
18151815

1816+
declare_lint! {
1817+
/// The `keyword_idents` lint detects edition keywords being used as an
1818+
/// identifier.
1819+
///
1820+
/// ### Example
1821+
///
1822+
/// ```rust,edition2015,compile_fail
1823+
/// #![deny(keyword_idents_2024)]
1824+
/// // edition 2015
1825+
/// fn gen() {}
1826+
/// ```
1827+
///
1828+
/// {{produces}}
1829+
///
1830+
/// ### Explanation
1831+
///
1832+
/// Rust [editions] allow the language to evolve without breaking
1833+
/// backwards compatibility. This lint catches code that uses new keywords
1834+
/// that are added to the language that are used as identifiers (such as a
1835+
/// variable name, function name, etc.). If you switch the compiler to a
1836+
/// new edition without updating the code, then it will fail to compile if
1837+
/// you are using a new keyword as an identifier.
1838+
///
1839+
/// You can manually change the identifiers to a non-keyword, or use a
1840+
/// [raw identifier], for example `r#gen`, to transition to a new edition.
1841+
///
1842+
/// This lint solves the problem automatically. It is "allow" by default
1843+
/// because the code is perfectly valid in older editions. The [`cargo
1844+
/// fix`] tool with the `--edition` flag will switch this lint to "warn"
1845+
/// and automatically apply the suggested fix from the compiler (which is
1846+
/// to use a raw identifier). This provides a completely automated way to
1847+
/// update old code for a new edition.
1848+
///
1849+
/// [editions]: https://doc.rust-lang.org/edition-guide/
1850+
/// [raw identifier]: https://doc.rust-lang.org/reference/identifiers.html
1851+
/// [`cargo fix`]: https://doc.rust-lang.org/cargo/commands/cargo-fix.html
1852+
pub KEYWORD_IDENTS_2024,
1853+
Allow,
1854+
"detects edition keywords being used as an identifier",
1855+
@future_incompatible = FutureIncompatibleInfo {
1856+
reason: FutureIncompatibilityReason::EditionError(Edition::Edition2024),
1857+
reference: "issue #49716 <https://github.com/rust-lang/rust/issues/49716>",
1858+
};
1859+
}
1860+
18161861
declare_lint_pass!(
18171862
/// Check for uses of edition keywords used as an identifier.
1818-
KeywordIdents => [KEYWORD_IDENTS]
1863+
KeywordIdents => [KEYWORD_IDENTS_2018, KEYWORD_IDENTS_2024]
18191864
);
18201865

18211866
struct UnderMacro(bool);
@@ -1841,42 +1886,39 @@ impl KeywordIdents {
18411886
UnderMacro(under_macro): UnderMacro,
18421887
ident: Ident,
18431888
) {
1844-
let next_edition = match cx.sess().edition() {
1845-
Edition::Edition2015 => {
1846-
match ident.name {
1847-
kw::Async | kw::Await | kw::Try => Edition::Edition2018,
1848-
1849-
// rust-lang/rust#56327: Conservatively do not
1850-
// attempt to report occurrences of `dyn` within
1851-
// macro definitions or invocations, because `dyn`
1852-
// can legitimately occur as a contextual keyword
1853-
// in 2015 code denoting its 2018 meaning, and we
1854-
// do not want rustfix to inject bugs into working
1855-
// code by rewriting such occurrences.
1856-
//
1857-
// But if we see `dyn` outside of a macro, we know
1858-
// its precise role in the parsed AST and thus are
1859-
// assured this is truly an attempt to use it as
1860-
// an identifier.
1861-
kw::Dyn if !under_macro => Edition::Edition2018,
1862-
1863-
_ => return,
1864-
}
1865-
}
1889+
let (lint, edition) = match ident.name {
1890+
kw::Async | kw::Await | kw::Try => (KEYWORD_IDENTS_2018, Edition::Edition2018),
1891+
1892+
// rust-lang/rust#56327: Conservatively do not
1893+
// attempt to report occurrences of `dyn` within
1894+
// macro definitions or invocations, because `dyn`
1895+
// can legitimately occur as a contextual keyword
1896+
// in 2015 code denoting its 2018 meaning, and we
1897+
// do not want rustfix to inject bugs into working
1898+
// code by rewriting such occurrences.
1899+
//
1900+
// But if we see `dyn` outside of a macro, we know
1901+
// its precise role in the parsed AST and thus are
1902+
// assured this is truly an attempt to use it as
1903+
// an identifier.
1904+
kw::Dyn if !under_macro => (KEYWORD_IDENTS_2018, Edition::Edition2018),
1905+
1906+
kw::Gen => (KEYWORD_IDENTS_2024, Edition::Edition2024),
18661907

1867-
// There are no new keywords yet for the 2018 edition and beyond.
18681908
_ => return,
18691909
};
18701910

18711911
// Don't lint `r#foo`.
1872-
if cx.sess().psess.raw_identifier_spans.contains(ident.span) {
1912+
if ident.span.edition() >= edition
1913+
|| cx.sess().psess.raw_identifier_spans.contains(ident.span)
1914+
{
18731915
return;
18741916
}
18751917

18761918
cx.emit_span_lint(
1877-
KEYWORD_IDENTS,
1919+
lint,
18781920
ident.span,
1879-
BuiltinKeywordIdents { kw: ident, next: next_edition, suggestion: ident.span },
1921+
BuiltinKeywordIdents { kw: ident, next: edition, suggestion: ident.span },
18801922
);
18811923
}
18821924
}

‎compiler/rustc_lint/src/lib.rs

+3-1
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,8 @@ fn register_builtins(store: &mut LintStore) {
313313
// MACRO_USE_EXTERN_CRATE
314314
);
315315

316+
add_lint_group!("keyword_idents", KEYWORD_IDENTS_2018, KEYWORD_IDENTS_2024);
317+
316318
add_lint_group!(
317319
"refining_impl_trait",
318320
REFINING_IMPL_TRAIT_REACHABLE,
@@ -325,7 +327,7 @@ fn register_builtins(store: &mut LintStore) {
325327
store.register_renamed("bare_trait_object", "bare_trait_objects");
326328
store.register_renamed("unstable_name_collision", "unstable_name_collisions");
327329
store.register_renamed("unused_doc_comment", "unused_doc_comments");
328-
store.register_renamed("async_idents", "keyword_idents");
330+
store.register_renamed("async_idents", "keyword_idents_2018");
329331
store.register_renamed("exceeding_bitshifts", "arithmetic_overflow");
330332
store.register_renamed("redundant_semicolon", "redundant_semicolons");
331333
store.register_renamed("overlapping_patterns", "overlapping_range_endpoints");

‎src/tools/lint-docs/src/groups.rs

+4
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ static GROUP_DESCRIPTIONS: &[(&str, &str)] = &[
2020
"refining-impl-trait",
2121
"Detects refinement of `impl Trait` return types by trait implementations",
2222
),
23+
(
24+
"keyword-idents",
25+
"Lints that detect identifiers which will be come keywords in later editions",
26+
),
2327
];
2428

2529
type LintGroups = BTreeMap<String, BTreeSet<String>>;

‎tests/ui/async-await/await-keyword/2015-edition-error-various-positions.stderr

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ note: the lint level is defined here
1111
|
1212
LL | #![deny(keyword_idents)]
1313
| ^^^^^^^^^^^^^^
14+
= note: `#[deny(keyword_idents_2018)]` implied by `#[deny(keyword_idents)]`
1415

1516
error: `await` is a keyword in the 2018 edition
1617
--> $DIR/2015-edition-error-various-positions.rs:7:20

‎tests/ui/async-await/await-keyword/2015-edition-warning.stderr

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ note: the lint level is defined here
1111
|
1212
LL | #![deny(keyword_idents)]
1313
| ^^^^^^^^^^^^^^
14+
= note: `#[deny(keyword_idents_2018)]` implied by `#[deny(keyword_idents)]`
1415

1516
error: `await` is a keyword in the 2018 edition
1617
--> $DIR/2015-edition-warning.rs:10:20

‎tests/ui/dyn-keyword/dyn-2015-edition-keyword-ident-lint.stderr

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ note: the lint level is defined here
1111
|
1212
LL | #![deny(keyword_idents)]
1313
| ^^^^^^^^^^^^^^
14+
= note: `#[deny(keyword_idents_2018)]` implied by `#[deny(keyword_idents)]`
1415

1516
error: `dyn` is a keyword in the 2018 edition
1617
--> $DIR/dyn-2015-edition-keyword-ident-lint.rs:17:20

‎tests/ui/lint/lint-pre-expansion-extern-module.stderr

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ LL | pub fn try() {}
66
|
77
= warning: this is accepted in the current edition (Rust 2015) but is a hard error in Rust 2018!
88
= note: for more information, see issue #49716 <https://github.com/rust-lang/rust/issues/49716>
9-
= note: `-W keyword-idents` implied by `-W rust-2018-compatibility`
10-
= help: to override `-W rust-2018-compatibility` add `#[allow(keyword_idents)]`
9+
= note: `-W keyword-idents-2018` implied by `-W rust-2018-compatibility`
10+
= help: to override `-W rust-2018-compatibility` add `#[allow(keyword_idents_2018)]`
1111

1212
warning: 1 warning emitted
1313

‎tests/ui/rust-2018/async-ident-allowed.stderr

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ note: the lint level is defined here
1111
|
1212
LL | #![deny(rust_2018_compatibility)]
1313
| ^^^^^^^^^^^^^^^^^^^^^^^
14-
= note: `#[deny(keyword_idents)]` implied by `#[deny(rust_2018_compatibility)]`
14+
= note: `#[deny(keyword_idents_2018)]` implied by `#[deny(rust_2018_compatibility)]`
1515

1616
error: aborting due to 1 previous error
1717

‎tests/ui/rust-2018/async-ident.stderr

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ note: the lint level is defined here
1111
|
1212
LL | #![deny(keyword_idents)]
1313
| ^^^^^^^^^^^^^^
14+
= note: `#[deny(keyword_idents_2018)]` implied by `#[deny(keyword_idents)]`
1415

1516
error: `async` is a keyword in the 2018 edition
1617
--> $DIR/async-ident.rs:12:7

‎tests/ui/rust-2018/dyn-keyword.stderr

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ note: the lint level is defined here
1111
|
1212
LL | #![deny(keyword_idents)]
1313
| ^^^^^^^^^^^^^^
14+
= note: `#[deny(keyword_idents_2018)]` implied by `#[deny(keyword_idents)]`
1415

1516
error: aborting due to 1 previous error
1617

‎tests/ui/rust-2018/try-ident.stderr

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ note: the lint level is defined here
1111
|
1212
LL | #![warn(rust_2018_compatibility)]
1313
| ^^^^^^^^^^^^^^^^^^^^^^^
14-
= note: `#[warn(keyword_idents)]` implied by `#[warn(rust_2018_compatibility)]`
14+
= note: `#[warn(keyword_idents_2018)]` implied by `#[warn(rust_2018_compatibility)]`
1515

1616
warning: `try` is a keyword in the 2018 edition
1717
--> $DIR/try-ident.rs:12:4

‎tests/ui/rust-2018/try-macro.stderr

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ note: the lint level is defined here
1111
|
1212
LL | #![warn(rust_2018_compatibility)]
1313
| ^^^^^^^^^^^^^^^^^^^^^^^
14-
= note: `#[warn(keyword_idents)]` implied by `#[warn(rust_2018_compatibility)]`
14+
= note: `#[warn(keyword_idents_2018)]` implied by `#[warn(rust_2018_compatibility)]`
1515

1616
warning: 1 warning emitted
1717

‎tests/ui/rust-2024/gen-kw.e2015.stderr

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
error: `gen` is a keyword in the 2024 edition
2+
--> $DIR/gen-kw.rs:6:4
3+
|
4+
LL | fn gen() {}
5+
| ^^^ help: you can use a raw identifier to stay compatible: `r#gen`
6+
|
7+
= warning: this is accepted in the current edition (Rust 2015) but is a hard error in Rust 2024!
8+
= note: for more information, see issue #49716 <https://github.com/rust-lang/rust/issues/49716>
9+
note: the lint level is defined here
10+
--> $DIR/gen-kw.rs:4:9
11+
|
12+
LL | #![deny(rust_2024_compatibility)]
13+
| ^^^^^^^^^^^^^^^^^^^^^^^
14+
= note: `#[deny(keyword_idents_2024)]` implied by `#[deny(rust_2024_compatibility)]`
15+
16+
error: `gen` is a keyword in the 2024 edition
17+
--> $DIR/gen-kw.rs:12:9
18+
|
19+
LL | let gen = r#gen;
20+
| ^^^ help: you can use a raw identifier to stay compatible: `r#gen`
21+
|
22+
= warning: this is accepted in the current edition (Rust 2015) but is a hard error in Rust 2024!
23+
= note: for more information, see issue #49716 <https://github.com/rust-lang/rust/issues/49716>
24+
25+
error: aborting due to 2 previous errors
26+

‎tests/ui/rust-2024/gen-kw.e2018.stderr

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
error: `gen` is a keyword in the 2024 edition
2+
--> $DIR/gen-kw.rs:6:4
3+
|
4+
LL | fn gen() {}
5+
| ^^^ help: you can use a raw identifier to stay compatible: `r#gen`
6+
|
7+
= warning: this is accepted in the current edition (Rust 2018) but is a hard error in Rust 2024!
8+
= note: for more information, see issue #49716 <https://github.com/rust-lang/rust/issues/49716>
9+
note: the lint level is defined here
10+
--> $DIR/gen-kw.rs:4:9
11+
|
12+
LL | #![deny(rust_2024_compatibility)]
13+
| ^^^^^^^^^^^^^^^^^^^^^^^
14+
= note: `#[deny(keyword_idents_2024)]` implied by `#[deny(rust_2024_compatibility)]`
15+
16+
error: `gen` is a keyword in the 2024 edition
17+
--> $DIR/gen-kw.rs:12:9
18+
|
19+
LL | let gen = r#gen;
20+
| ^^^ help: you can use a raw identifier to stay compatible: `r#gen`
21+
|
22+
= warning: this is accepted in the current edition (Rust 2018) but is a hard error in Rust 2024!
23+
= note: for more information, see issue #49716 <https://github.com/rust-lang/rust/issues/49716>
24+
25+
error: aborting due to 2 previous errors
26+

‎tests/ui/rust-2024/gen-kw.rs

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
//@ revisions: e2015 e2018
2+
//@[e2018] edition: 2018
3+
4+
#![deny(rust_2024_compatibility)]
5+
6+
fn gen() {}
7+
//~^ ERROR `gen` is a keyword in the 2024 edition
8+
//[e2015]~| WARNING this is accepted in the current edition (Rust 2015) but is a hard error in Rust 2024!
9+
//[e2018]~| WARNING this is accepted in the current edition (Rust 2018) but is a hard error in Rust 2024!
10+
11+
fn main() {
12+
let gen = r#gen;
13+
//~^ ERROR `gen` is a keyword in the 2024 edition
14+
//[e2015]~| WARNING this is accepted in the current edition (Rust 2015) but is a hard error in Rust 2024!
15+
//[e2018]~| WARNING this is accepted in the current edition (Rust 2018) but is a hard error in Rust 2024!
16+
}

0 commit comments

Comments
 (0)