-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Fix range literals borrowing suggestions #54734
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
Changes from 3 commits
0626afb
f7d35cc
87bf9e2
611e5c4
882e373
1f7dafb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -309,11 +309,20 @@ impl<'a, 'gcx, 'tcx> FnCtxt<'a, 'gcx, 'tcx> { | |
}; | ||
if self.can_coerce(ref_ty, expected) { | ||
if let Ok(src) = cm.span_to_snippet(sp) { | ||
let sugg_expr = match expr.node { // parenthesize if needed (Issue #46756) | ||
let needs_parens = match expr.node { | ||
// parenthesize if needed (Issue #46756) | ||
hir::ExprKind::Cast(_, _) | | ||
hir::ExprKind::Binary(_, _, _) => format!("({})", src), | ||
_ => src, | ||
hir::ExprKind::Binary(_, _, _) => true, | ||
// parenthesize borrows of range literals (Issue #54505) | ||
_ if self.is_range_literal(expr) => true, | ||
_ => false, | ||
}; | ||
let sugg_expr = if needs_parens { | ||
format!("({})", src) | ||
} else { | ||
src | ||
}; | ||
|
||
if let Some(sugg) = self.can_use_as_ref(expr) { | ||
return Some(sugg); | ||
} | ||
|
@@ -374,6 +383,66 @@ impl<'a, 'gcx, 'tcx> FnCtxt<'a, 'gcx, 'tcx> { | |
None | ||
} | ||
|
||
/// This function checks if the specified expression is a built-in range literal. | ||
/// (See: ``librustc::hir::lowering::LoweringContext::lower_expr()``). | ||
fn is_range_literal(&self, expr: &hir::Expr) -> bool { | ||
use hir::{Path, QPath, ExprKind, TyKind}; | ||
|
||
// We support `::std::ops::Range` and `::core::ops::Range` prefixes | ||
let is_range_path = |path: &Path| { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I might be alone in this (cc @estebank), but I think for a short path like this, a more explicit approach (like below) is more readable. (I specifically don't like splitting on "|" because it feels a little too ad hoc.) let is_range_path = |path: &Path| {
let segs = path.segments.iter().map(|seg| seg.ident.as_str());
if let (Some("{{root}}"), std_core, "ops", range, None) = (segs.next(), segs.next(), segs.next(), segs.next(), segs.next()) {
(std_core == "std" || std_core == "ops") && range.starts_with("Range")
} else {
false
}
}; There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's a great suggestion! I was looking for something concise like this syntax-wise, it didn't occur to me that I could use |
||
let mut segs = path.segments.iter() | ||
.map(|seg| seg.ident.as_str()); | ||
|
||
if let (Some(root), Some(std_core), Some(ops), Some(range), None) = | ||
(segs.next(), segs.next(), segs.next(), segs.next(), segs.next()) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
{ | ||
// "{{root}}" is the equivalent of `::` prefix in Path | ||
root == "{{root}}" && (std_core == "std" || std_core == "core") | ||
&& ops == "ops" && range.starts_with("Range") | ||
} else { | ||
false | ||
} | ||
}; | ||
|
||
let is_range_literal = |span: &Span| { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As you pointed out, it would be clearer to give this a different name than the function it's in. Maybe |
||
// Tell if expression span snippet doesn't look like an explicit | ||
// Range struct or `new()` call. This is to allow inferring | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Inferring" has a very specific meaning, so I'd tend to avoid it in favour of something like: // Check whether a span corresponding to a range is a range literal,
// rather than an explicit struct or `new()` call. |
||
// that this is a range literal. | ||
let source_map = self.tcx.sess.source_map(); | ||
let end_point = source_map.end_point(*span); | ||
|
||
if let Ok(end_string) = source_map.span_to_snippet(end_point) { | ||
!(end_string.ends_with("}") || end_string.ends_with(")")) | ||
} else { | ||
false | ||
} | ||
}; | ||
|
||
match expr.node { | ||
// All built-in range literals but `..=` and `..` desugar to Structs | ||
ExprKind::Struct(QPath::Resolved(None, ref path), _, _) | | ||
// `..` desugars to its struct path | ||
ExprKind::Path(QPath::Resolved(None, ref path)) => { | ||
pawroman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
return is_range_path(&path) && is_range_literal(&expr.span); | ||
} | ||
|
||
// `..=` desugars into `::std::ops::RangeInclusive::new(...)` | ||
ExprKind::Call(ref func, _) => { | ||
if let ExprKind::Path(QPath::TypeRelative(ref ty, ref segment)) = func.node { | ||
if let TyKind::Path(QPath::Resolved(None, ref path)) = ty.node { | ||
let call_to_new = segment.ident.as_str() == "new"; | ||
|
||
return is_range_path(&path) && is_range_literal(&expr.span) && call_to_new; | ||
} | ||
} | ||
} | ||
|
||
_ => {} | ||
} | ||
|
||
false | ||
varkor marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
pub fn check_for_cast(&self, | ||
err: &mut DiagnosticBuilder<'tcx>, | ||
expr: &hir::Expr, | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
// run-rustfix | ||
|
||
// Regression test for changes introduced while fixing #54505 | ||
|
||
// This test uses non-literals for Ranges | ||
// (expecting no parens with borrow suggestion) | ||
|
||
use std::ops::RangeBounds; | ||
|
||
|
||
// take a reference to any built-in range | ||
fn take_range(_r: &impl RangeBounds<i8>) {} | ||
|
||
|
||
fn main() { | ||
take_range(&std::ops::Range { start: 0, end: 1 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::Range { start: 0, end: 1 } | ||
|
||
take_range(&::std::ops::Range { start: 0, end: 1 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::Range { start: 0, end: 1 } | ||
|
||
take_range(&std::ops::RangeFrom { start: 1 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::RangeFrom { start: 1 } | ||
|
||
take_range(&::std::ops::RangeFrom { start: 1 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::RangeFrom { start: 1 } | ||
|
||
take_range(&std::ops::RangeFull {}); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::RangeFull {} | ||
|
||
take_range(&::std::ops::RangeFull {}); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::RangeFull {} | ||
|
||
take_range(&std::ops::RangeInclusive::new(0, 1)); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::RangeInclusive::new(0, 1) | ||
|
||
take_range(&::std::ops::RangeInclusive::new(0, 1)); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::RangeInclusive::new(0, 1) | ||
|
||
take_range(&std::ops::RangeTo { end: 5 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::RangeTo { end: 5 } | ||
|
||
take_range(&::std::ops::RangeTo { end: 5 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::RangeTo { end: 5 } | ||
|
||
take_range(&std::ops::RangeToInclusive { end: 5 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::RangeToInclusive { end: 5 } | ||
|
||
take_range(&::std::ops::RangeToInclusive { end: 5 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::RangeToInclusive { end: 5 } | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
// run-rustfix | ||
|
||
// Regression test for changes introduced while fixing #54505 | ||
|
||
// This test uses non-literals for Ranges | ||
// (expecting no parens with borrow suggestion) | ||
|
||
use std::ops::RangeBounds; | ||
|
||
|
||
// take a reference to any built-in range | ||
fn take_range(_r: &impl RangeBounds<i8>) {} | ||
|
||
|
||
fn main() { | ||
take_range(std::ops::Range { start: 0, end: 1 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::Range { start: 0, end: 1 } | ||
|
||
take_range(::std::ops::Range { start: 0, end: 1 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::Range { start: 0, end: 1 } | ||
|
||
take_range(std::ops::RangeFrom { start: 1 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::RangeFrom { start: 1 } | ||
|
||
take_range(::std::ops::RangeFrom { start: 1 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::RangeFrom { start: 1 } | ||
|
||
take_range(std::ops::RangeFull {}); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::RangeFull {} | ||
|
||
take_range(::std::ops::RangeFull {}); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::RangeFull {} | ||
|
||
take_range(std::ops::RangeInclusive::new(0, 1)); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::RangeInclusive::new(0, 1) | ||
|
||
take_range(::std::ops::RangeInclusive::new(0, 1)); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::RangeInclusive::new(0, 1) | ||
|
||
take_range(std::ops::RangeTo { end: 5 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::RangeTo { end: 5 } | ||
|
||
take_range(::std::ops::RangeTo { end: 5 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::RangeTo { end: 5 } | ||
|
||
take_range(std::ops::RangeToInclusive { end: 5 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &std::ops::RangeToInclusive { end: 5 } | ||
|
||
take_range(::std::ops::RangeToInclusive { end: 5 }); | ||
//~^ ERROR mismatched types [E0308] | ||
//~| HELP consider borrowing here | ||
//~| SUGGESTION &::std::ops::RangeToInclusive { end: 5 } | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:16:16 | ||
| | ||
LL | take_range(std::ops::Range { start: 0, end: 1 }); | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::Range` | ||
| help: consider borrowing here: `&std::ops::Range { start: 0, end: 1 }` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::Range<{integer}>` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:21:16 | ||
| | ||
LL | take_range(::std::ops::Range { start: 0, end: 1 }); | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::Range` | ||
| help: consider borrowing here: `&::std::ops::Range { start: 0, end: 1 }` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::Range<{integer}>` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:26:16 | ||
| | ||
LL | take_range(std::ops::RangeFrom { start: 1 }); | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::RangeFrom` | ||
| help: consider borrowing here: `&std::ops::RangeFrom { start: 1 }` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::RangeFrom<{integer}>` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:31:16 | ||
| | ||
LL | take_range(::std::ops::RangeFrom { start: 1 }); | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::RangeFrom` | ||
| help: consider borrowing here: `&::std::ops::RangeFrom { start: 1 }` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::RangeFrom<{integer}>` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:36:16 | ||
| | ||
LL | take_range(std::ops::RangeFull {}); | ||
| ^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::RangeFull` | ||
| help: consider borrowing here: `&std::ops::RangeFull {}` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::RangeFull` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:41:16 | ||
| | ||
LL | take_range(::std::ops::RangeFull {}); | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::RangeFull` | ||
| help: consider borrowing here: `&::std::ops::RangeFull {}` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::RangeFull` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:46:16 | ||
| | ||
LL | take_range(std::ops::RangeInclusive::new(0, 1)); | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::RangeInclusive` | ||
| help: consider borrowing here: `&std::ops::RangeInclusive::new(0, 1)` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::RangeInclusive<{integer}>` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:51:16 | ||
| | ||
LL | take_range(::std::ops::RangeInclusive::new(0, 1)); | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::RangeInclusive` | ||
| help: consider borrowing here: `&::std::ops::RangeInclusive::new(0, 1)` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::RangeInclusive<{integer}>` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:56:16 | ||
| | ||
LL | take_range(std::ops::RangeTo { end: 5 }); | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::RangeTo` | ||
| help: consider borrowing here: `&std::ops::RangeTo { end: 5 }` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::RangeTo<{integer}>` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:61:16 | ||
| | ||
LL | take_range(::std::ops::RangeTo { end: 5 }); | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::RangeTo` | ||
| help: consider borrowing here: `&::std::ops::RangeTo { end: 5 }` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::RangeTo<{integer}>` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:66:16 | ||
| | ||
LL | take_range(std::ops::RangeToInclusive { end: 5 }); | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::RangeToInclusive` | ||
| help: consider borrowing here: `&std::ops::RangeToInclusive { end: 5 }` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::RangeToInclusive<{integer}>` | ||
|
||
error[E0308]: mismatched types | ||
--> $DIR/issue-54505-no-literals.rs:71:16 | ||
| | ||
LL | take_range(::std::ops::RangeToInclusive { end: 5 }); | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | | ||
| expected reference, found struct `std::ops::RangeToInclusive` | ||
| help: consider borrowing here: `&::std::ops::RangeToInclusive { end: 5 }` | ||
| | ||
= note: expected type `&_` | ||
found type `std::ops::RangeToInclusive<{integer}>` | ||
|
||
error: aborting due to 12 previous errors | ||
|
||
For more information about this error, try `rustc --explain E0308`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I meant single rather than double backticks; I should have clarified. On second thoughts, though, it might be more convenient to include the path:
/// (See `LoweringContext::lower_expr()` in `src/librustc/hir/lowering.rs`.)
as then someone can jump straight to the path. (Like in the following.)
https://github.com/rust-lang/rust/blob/f89622a7548f69c76e5c9857e34be568ba322d02/src/librustc_privacy/lib.rs#L1388