Skip to content

Commit

Permalink
Recover wrong cased keywords starting functions
Browse files Browse the repository at this point in the history
  • Loading branch information
WaffleLapkin committed Oct 1, 2022
1 parent 3694429 commit 38b0865
Show file tree
Hide file tree
Showing 8 changed files with 205 additions and 51 deletions.
9 changes: 9 additions & 0 deletions compiler/rustc_ast/src/token.rs
Original file line number Diff line number Diff line change
Expand Up @@ -618,6 +618,15 @@ impl Token {
self.is_non_raw_ident_where(|id| id.name == kw)
}

/// Returns `true` if the token is a given keyword, `kw` or if `case_insensitive` is true and this token is an identifier equal to `kw` ignoring the case.
pub fn is_keyword_case(&self, kw: Symbol, case_insensitive: bool) -> bool {
self.is_keyword(kw)
|| (case_insensitive
&& self.is_non_raw_ident_where(|id| {
id.name.as_str().to_lowercase() == kw.as_str().to_lowercase()
}))
}

pub fn is_path_segment_keyword(&self) -> bool {
self.is_non_raw_ident_where(Ident::is_path_segment_keyword)
}
Expand Down
2 changes: 1 addition & 1 deletion compiler/rustc_parse/src/parser/expr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2024,7 +2024,7 @@ impl<'a> Parser<'a> {
if self.eat_keyword(kw::Static) { Movability::Static } else { Movability::Movable };

let asyncness = if self.token.uninterpolated_span().rust_2018() {
self.parse_asyncness()
self.parse_asyncness(false)
} else {
Async::No
};
Expand Down
79 changes: 42 additions & 37 deletions compiler/rustc_parse/src/parser/item.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ impl<'a> Parser<'a> {

/// Parses a `mod <foo> { ... }` or `mod <foo>;` item.
fn parse_item_mod(&mut self, attrs: &mut AttrVec) -> PResult<'a, ItemInfo> {
let unsafety = self.parse_unsafety();
let unsafety = self.parse_unsafety(false);
self.expect_keyword(kw::Mod)?;
let id = self.parse_ident()?;
let mod_kind = if self.eat(&token::Semi) {
Expand Down Expand Up @@ -215,14 +215,14 @@ impl<'a> Parser<'a> {
kw_case_insensitive: bool,
) -> PResult<'a, Option<ItemInfo>> {
let def_final = def == &Defaultness::Final;
let mut def = || mem::replace(def, Defaultness::Final);
let mut def_ = || mem::replace(def, Defaultness::Final);

let info = if self.eat_keyword_case(kw::Use, kw_case_insensitive) {
self.parse_use_item()?
} else if self.check_fn_front_matter(def_final) {
} else if self.check_fn_front_matter(def_final, kw_case_insensitive) {
// FUNCTION ITEM
let (ident, sig, generics, body) = self.parse_fn(attrs, fn_parse_mode, lo, vis)?;
(ident, ItemKind::Fn(Box::new(Fn { defaultness: def(), sig, generics, body })))
(ident, ItemKind::Fn(Box::new(Fn { defaultness: def_(), sig, generics, body })))
} else if self.eat_keyword(kw::Extern) {
if self.eat_keyword(kw::Crate) {
// EXTERN CRATE
Expand All @@ -233,7 +233,7 @@ impl<'a> Parser<'a> {
}
} else if self.is_unsafe_foreign_mod() {
// EXTERN BLOCK
let unsafety = self.parse_unsafety();
let unsafety = self.parse_unsafety(false);
self.expect_keyword(kw::Extern)?;
self.parse_item_foreign_mod(attrs, unsafety)?
} else if self.is_static_global() {
Expand All @@ -242,15 +242,15 @@ impl<'a> Parser<'a> {
let m = self.parse_mutability();
let (ident, ty, expr) = self.parse_item_global(Some(m))?;
(ident, ItemKind::Static(ty, m, expr))
} else if let Const::Yes(const_span) = self.parse_constness() {
} else if let Const::Yes(const_span) = self.parse_constness(false) {
// CONST ITEM
if self.token.is_keyword(kw::Impl) {
// recover from `const impl`, suggest `impl const`
self.recover_const_impl(const_span, attrs, def())?
self.recover_const_impl(const_span, attrs, def_())?
} else {
self.recover_const_mut(const_span);
let (ident, ty, expr) = self.parse_item_global(None)?;
(ident, ItemKind::Const(def(), ty, expr))
(ident, ItemKind::Const(def_(), ty, expr))
}
} else if self.check_keyword(kw::Trait) || self.check_auto_or_unsafe_trait_item() {
// TRAIT ITEM
Expand All @@ -259,15 +259,15 @@ impl<'a> Parser<'a> {
|| self.check_keyword(kw::Unsafe) && self.is_keyword_ahead(1, &[kw::Impl])
{
// IMPL ITEM
self.parse_item_impl(attrs, def())?
self.parse_item_impl(attrs, def_())?
} else if self.check_keyword(kw::Mod)
|| self.check_keyword(kw::Unsafe) && self.is_keyword_ahead(1, &[kw::Mod])
{
// MODULE ITEM
self.parse_item_mod(attrs)?
} else if self.eat_keyword(kw::Type) {
// TYPE ITEM
self.parse_type_alias(def())?
self.parse_type_alias(def_())?
} else if self.eat_keyword(kw::Enum) {
// ENUM ITEM
self.parse_item_enum()?
Expand Down Expand Up @@ -295,16 +295,10 @@ impl<'a> Parser<'a> {
self.recover_missing_kw_before_item()?;
return Ok(None);
} else if self.isnt_macro_invocation() && !kw_case_insensitive {
_ = def_;

// Recover wrong cased keywords
return self.parse_item_kind(
attrs,
macros_allowed,
lo,
vis,
&mut def(),
fn_parse_mode,
true,
);
return self.parse_item_kind(attrs, macros_allowed, lo, vis, def, fn_parse_mode, true);
} else if macros_allowed && self.check_path() {
// MACRO INVOCATION ITEM
(Ident::empty(), ItemKind::MacCall(P(self.parse_item_macro(vis)?)))
Expand Down Expand Up @@ -557,7 +551,7 @@ impl<'a> Parser<'a> {
attrs: &mut AttrVec,
defaultness: Defaultness,
) -> PResult<'a, ItemInfo> {
let unsafety = self.parse_unsafety();
let unsafety = self.parse_unsafety(false);
self.expect_keyword(kw::Impl)?;

// First, parse generic parameters if necessary.
Expand All @@ -571,7 +565,7 @@ impl<'a> Parser<'a> {
generics
};

let constness = self.parse_constness();
let constness = self.parse_constness(false);
if let Const::Yes(span) = constness {
self.sess.gated_spans.gate(sym::const_trait_impl, span);
}
Expand Down Expand Up @@ -815,7 +809,7 @@ impl<'a> Parser<'a> {

/// Parses `unsafe? auto? trait Foo { ... }` or `trait Foo = Bar;`.
fn parse_item_trait(&mut self, attrs: &mut AttrVec, lo: Span) -> PResult<'a, ItemInfo> {
let unsafety = self.parse_unsafety();
let unsafety = self.parse_unsafety(false);
// Parse optional `auto` prefix.
let is_auto = if self.eat_keyword(kw::Auto) { IsAuto::Yes } else { IsAuto::No };

Expand Down Expand Up @@ -1764,7 +1758,7 @@ impl<'a> Parser<'a> {
let (ident, is_raw) = self.ident_or_err()?;
if !is_raw && ident.is_reserved() {
let snapshot = self.create_snapshot_for_diagnostic();
let err = if self.check_fn_front_matter(false) {
let err = if self.check_fn_front_matter(false, false) {
let inherited_vis = Visibility {
span: rustc_span::DUMMY_SP,
kind: VisibilityKind::Inherited,
Expand Down Expand Up @@ -2153,7 +2147,11 @@ impl<'a> Parser<'a> {
///
/// `check_pub` adds additional `pub` to the checks in case users place it
/// wrongly, can be used to ensure `pub` never comes after `default`.
pub(super) fn check_fn_front_matter(&mut self, check_pub: bool) -> bool {
pub(super) fn check_fn_front_matter(
&mut self,
check_pub: bool,
kw_case_insensitive: bool,
) -> bool {
// We use an over-approximation here.
// `const const`, `fn const` won't parse, but we're not stepping over other syntax either.
// `pub` is added in case users got confused with the ordering like `async pub fn`,
Expand All @@ -2163,23 +2161,30 @@ impl<'a> Parser<'a> {
} else {
&[kw::Const, kw::Async, kw::Unsafe, kw::Extern]
};
self.check_keyword(kw::Fn) // Definitely an `fn`.
self.check_keyword_case(kw::Fn, kw_case_insensitive) // Definitely an `fn`.
// `$qual fn` or `$qual $qual`:
|| quals.iter().any(|&kw| self.check_keyword(kw))
|| quals.iter().any(|&kw| self.check_keyword_case(kw, kw_case_insensitive))
&& self.look_ahead(1, |t| {
// `$qual fn`, e.g. `const fn` or `async fn`.
t.is_keyword(kw::Fn)
t.is_keyword_case(kw::Fn, kw_case_insensitive)
// Two qualifiers `$qual $qual` is enough, e.g. `async unsafe`.
|| t.is_non_raw_ident_where(|i| quals.contains(&i.name)
// Rule out 2015 `const async: T = val`.
&& i.is_reserved()
|| (
(
t.is_non_raw_ident_where(|i|
quals.contains(&i.name)
// Rule out 2015 `const async: T = val`.
&& i.is_reserved()
)
|| kw_case_insensitive
&& t.is_non_raw_ident_where(|i| quals.iter().any(|qual| qual.as_str() == i.name.as_str().to_lowercase()))
)
// Rule out unsafe extern block.
&& !self.is_unsafe_foreign_mod())
})
// `extern ABI fn`
|| self.check_keyword(kw::Extern)
|| self.check_keyword_case(kw::Extern, kw_case_insensitive)
&& self.look_ahead(1, |t| t.can_begin_literal_maybe_minus())
&& self.look_ahead(2, |t| t.is_keyword(kw::Fn))
&& self.look_ahead(2, |t| t.is_keyword_case(kw::Fn, kw_case_insensitive))
}

/// Parses all the "front matter" (or "qualifiers") for a `fn` declaration,
Expand All @@ -2195,22 +2200,22 @@ impl<'a> Parser<'a> {
/// `Visibility::Inherited` when no visibility is known.
pub(super) fn parse_fn_front_matter(&mut self, orig_vis: &Visibility) -> PResult<'a, FnHeader> {
let sp_start = self.token.span;
let constness = self.parse_constness();
let constness = self.parse_constness(true);

let async_start_sp = self.token.span;
let asyncness = self.parse_asyncness();
let asyncness = self.parse_asyncness(true);

let unsafe_start_sp = self.token.span;
let unsafety = self.parse_unsafety();
let unsafety = self.parse_unsafety(true);

let ext_start_sp = self.token.span;
let ext = self.parse_extern();
let ext = self.parse_extern(true);

if let Async::Yes { span, .. } = asyncness {
self.ban_async_in_2015(span);
}

if !self.eat_keyword(kw::Fn) {
if !self.eat_keyword_case(kw::Fn, true) {
// It is possible for `expect_one_of` to recover given the contents of
// `self.expected_tokens`, therefore, do not use `self.unexpected()` which doesn't
// account for this.
Expand Down
30 changes: 22 additions & 8 deletions compiler/rustc_parse/src/parser/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -604,6 +604,20 @@ impl<'a> Parser<'a> {
self.token.is_keyword(kw)
}

fn check_keyword_case(&mut self, kw: Symbol, case_insensitive: bool) -> bool {
if self.check_keyword(kw) {
return true;
}

if case_insensitive
&& let Some((ident, /* is_raw */ false)) = self.token.ident()
&& ident.as_str().to_lowercase() == kw.as_str().to_lowercase() {
true
} else {
false
}
}

/// If the next token is the given keyword, eats it and returns `true`.
/// Otherwise, returns `false`. An expectation is also added for diagnostics purposes.
// Public for rustfmt usage.
Expand Down Expand Up @@ -1122,8 +1136,8 @@ impl<'a> Parser<'a> {
}

/// Parses asyncness: `async` or nothing.
fn parse_asyncness(&mut self) -> Async {
if self.eat_keyword(kw::Async) {
fn parse_asyncness(&mut self, case_insensitive: bool) -> Async {
if self.eat_keyword_case(kw::Async, case_insensitive) {
let span = self.prev_token.uninterpolated_span();
Async::Yes { span, closure_id: DUMMY_NODE_ID, return_impl_trait_id: DUMMY_NODE_ID }
} else {
Expand All @@ -1132,19 +1146,19 @@ impl<'a> Parser<'a> {
}

/// Parses unsafety: `unsafe` or nothing.
fn parse_unsafety(&mut self) -> Unsafe {
if self.eat_keyword(kw::Unsafe) {
fn parse_unsafety(&mut self, case_insensitive: bool) -> Unsafe {
if self.eat_keyword_case(kw::Unsafe, case_insensitive) {
Unsafe::Yes(self.prev_token.uninterpolated_span())
} else {
Unsafe::No
}
}

/// Parses constness: `const` or nothing.
fn parse_constness(&mut self) -> Const {
fn parse_constness(&mut self, case_insensitive: bool) -> Const {
// Avoid const blocks to be parsed as const items
if self.look_ahead(1, |t| t != &token::OpenDelim(Delimiter::Brace))
&& self.eat_keyword(kw::Const)
&& self.eat_keyword_case(kw::Const, case_insensitive)
{
Const::Yes(self.prev_token.uninterpolated_span())
} else {
Expand Down Expand Up @@ -1399,8 +1413,8 @@ impl<'a> Parser<'a> {
}

/// Parses `extern string_literal?`.
fn parse_extern(&mut self) -> Extern {
if self.eat_keyword(kw::Extern) {
fn parse_extern(&mut self, case_insensitive: bool) -> Extern {
if self.eat_keyword_case(kw::Extern, case_insensitive) {
let mut extern_span = self.prev_token.span;
let abi = self.parse_abi();
if let Some(abi) = abi {
Expand Down
4 changes: 2 additions & 2 deletions compiler/rustc_parse/src/parser/ty.rs
Original file line number Diff line number Diff line change
Expand Up @@ -267,15 +267,15 @@ impl<'a> Parser<'a> {
} else if self.eat_keyword(kw::Underscore) {
// A type to be inferred `_`
TyKind::Infer
} else if self.check_fn_front_matter(false) {
} else if self.check_fn_front_matter(false, false) {
// Function pointer type
self.parse_ty_bare_fn(lo, Vec::new(), recover_return_sign)?
} else if self.check_keyword(kw::For) {
// Function pointer type or bound list (trait object type) starting with a poly-trait.
// `for<'lt> [unsafe] [extern "ABI"] fn (&'lt S) -> T`
// `for<'lt> Trait1<'lt> + Trait2 + 'a`
let lifetime_defs = self.parse_late_bound_lifetime_defs()?;
if self.check_fn_front_matter(false) {
if self.check_fn_front_matter(false, false) {
self.parse_ty_bare_fn(lo, lifetime_defs, recover_return_sign)?
} else {
let path = self.parse_path(PathStyle::Type)?;
Expand Down
27 changes: 27 additions & 0 deletions src/test/ui/parser/item-kw-case-mismatch.fixed
Original file line number Diff line number Diff line change
@@ -1,7 +1,34 @@
// run-rustfix
// edition:2018
#![allow(unused_imports)]

fn main() {}

use std::ptr::read; //~ ERROR keyword `use` is written in a wrong case
use std::ptr::write; //~ ERROR keyword `use` is written in a wrong case

async fn _a() {}
//~^ ERROR keyword `fn` is written in a wrong case

fn _b() {}
//~^ ERROR keyword `fn` is written in a wrong case

async fn _c() {}
//~^ ERROR keyword `async` is written in a wrong case
//~| ERROR keyword `fn` is written in a wrong case

async fn _d() {}
//~^ ERROR keyword `async` is written in a wrong case

const unsafe fn _e() {}
//~^ ERROR keyword `const` is written in a wrong case
//~| ERROR keyword `unsafe` is written in a wrong case
//~| ERROR keyword `fn` is written in a wrong case

unsafe extern fn _f() {}
//~^ ERROR keyword `unsafe` is written in a wrong case
//~| ERROR keyword `extern` is written in a wrong case

extern "C" fn _g() {}
//~^ ERROR keyword `extern` is written in a wrong case
//~| ERROR keyword `fn` is written in a wrong case
27 changes: 27 additions & 0 deletions src/test/ui/parser/item-kw-case-mismatch.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,34 @@
// run-rustfix
// edition:2018
#![allow(unused_imports)]

fn main() {}

Use std::ptr::read; //~ ERROR keyword `use` is written in a wrong case
USE std::ptr::write; //~ ERROR keyword `use` is written in a wrong case

async Fn _a() {}
//~^ ERROR keyword `fn` is written in a wrong case

Fn _b() {}
//~^ ERROR keyword `fn` is written in a wrong case

aSYNC fN _c() {}
//~^ ERROR keyword `async` is written in a wrong case
//~| ERROR keyword `fn` is written in a wrong case

Async fn _d() {}
//~^ ERROR keyword `async` is written in a wrong case

CONST UNSAFE FN _e() {}
//~^ ERROR keyword `const` is written in a wrong case
//~| ERROR keyword `unsafe` is written in a wrong case
//~| ERROR keyword `fn` is written in a wrong case

unSAFE EXTern fn _f() {}
//~^ ERROR keyword `unsafe` is written in a wrong case
//~| ERROR keyword `extern` is written in a wrong case

EXTERN "C" FN _g() {}
//~^ ERROR keyword `extern` is written in a wrong case
//~| ERROR keyword `fn` is written in a wrong case
Loading

0 comments on commit 38b0865

Please sign in to comment.