feat: Closure capture inlay hints #14742
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| //! Implementation of "closure return type" inlay hints. | ||
| //! | ||
| //! Tests live in [`bind_pat`][super::bind_pat] module. | ||
| use ide_db::{base_db::FileId, famous_defs::FamousDefs}; | ||
| use syntax::ast::{self, AstNode}; | ||
| use text_edit::{TextRange, TextSize}; | ||
|
|
||
| use crate::{InlayHint, InlayHintLabel, InlayHintsConfig, InlayKind}; | ||
|
|
||
| pub(super) fn hints( | ||
| acc: &mut Vec<InlayHint>, | ||
| FamousDefs(sema, _): &FamousDefs<'_, '_>, | ||
| config: &InlayHintsConfig, | ||
| _file_id: FileId, | ||
| closure: ast::ClosureExpr, | ||
| ) -> Option<()> { | ||
| if !config.closure_capture_hints { | ||
| return None; | ||
| } | ||
| let ty = &sema.type_of_expr(&closure.clone().into())?.original; | ||
| let c = ty.as_closure()?; | ||
| let captures = c.captured_items(sema.db); | ||
|
|
||
| if captures.is_empty() { | ||
| return None; | ||
| } | ||
|
|
||
| let move_kw_range = match closure.move_token() { | ||
| Some(t) => t.text_range(), | ||
| None => { | ||
| let range = closure.syntax().first_token()?.prev_token()?.text_range(); | ||
| let range = TextRange::new(range.end() - TextSize::from(1), range.end()); | ||
| acc.push(InlayHint { | ||
| range, | ||
| kind: InlayKind::ClosureCapture, | ||
| label: InlayHintLabel::simple("move", None, None), | ||
| text_edit: None, | ||
| }); | ||
| range | ||
| } | ||
| }; | ||
| acc.push(InlayHint { | ||
| range: move_kw_range, | ||
| kind: InlayKind::ClosureCapture, | ||
| label: InlayHintLabel::from("("), | ||
| text_edit: None, | ||
| }); | ||
| let last = captures.len() - 1; | ||
| for (idx, capture) in captures.into_iter().enumerate() { | ||
| let local = capture.local(); | ||
Veykril marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| let source = local.primary_source(sema.db); | ||
|
|
||
| // force cache the source file, otherwise sema lookup will potentially panic | ||
| _ = sema.parse_or_expand(source.file()); | ||
|
|
||
| acc.push(InlayHint { | ||
| range: move_kw_range, | ||
| kind: InlayKind::ClosureCapture, | ||
| label: InlayHintLabel::simple( | ||
| format!( | ||
| "{}{}", | ||
| match capture.kind() { | ||
| hir::CaptureKind::SharedRef => "&", | ||
| hir::CaptureKind::UniqueSharedRef => "&unique ", | ||
| hir::CaptureKind::MutableRef => "&mut ", | ||
| hir::CaptureKind::Move => "", | ||
| }, | ||
| local.name(sema.db) | ||
| ), | ||
| None, | ||
| source.name().and_then(|name| sema.original_range_opt(name.syntax())), | ||
| ), | ||
| text_edit: None, | ||
| }); | ||
|
|
||
| if idx != last { | ||
| acc.push(InlayHint { | ||
| range: move_kw_range, | ||
| kind: InlayKind::ClosureCapture, | ||
| label: InlayHintLabel::simple(", ", None, None), | ||
| text_edit: None, | ||
| }); | ||
| } | ||
| } | ||
| acc.push(InlayHint { | ||
| range: move_kw_range, | ||
| kind: InlayKind::ClosureCapture, | ||
| label: InlayHintLabel::from(")"), | ||
| text_edit: None, | ||
| }); | ||
|
|
||
| Some(()) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use crate::{ | ||
| inlay_hints::tests::{check_with_config, DISABLED_CONFIG}, | ||
| InlayHintsConfig, | ||
| }; | ||
|
|
||
| #[test] | ||
| fn all_capture_kinds() { | ||
| check_with_config( | ||
| InlayHintsConfig { closure_capture_hints: true, ..DISABLED_CONFIG }, | ||
| r#" | ||
| //- minicore: copy, derive | ||
|
|
||
|
|
||
| #[derive(Copy, Clone)] | ||
| struct Copy; | ||
|
|
||
| struct NonCopy; | ||
|
|
||
| fn main() { | ||
| let foo = Copy; | ||
| let bar = NonCopy; | ||
| let mut baz = NonCopy; | ||
| let qux = &mut NonCopy; | ||
| || { | ||
| // ^ move | ||
| // ^ ( | ||
| // ^ &foo | ||
| // ^ , | ||
| // ^ bar | ||
| // ^ , | ||
| // ^ baz | ||
| // ^ , | ||
| // ^ qux | ||
| // ^ ) | ||
| foo; | ||
| bar; | ||
| baz; | ||
| qux; | ||
| }; | ||
| || { | ||
| // ^ move | ||
| // ^ ( | ||
| // ^ &foo | ||
| // ^ , | ||
| // ^ &bar | ||
| // ^ , | ||
| // ^ &baz | ||
| // ^ , | ||
| // ^ &qux | ||
| // ^ ) | ||
| &foo; | ||
| &bar; | ||
| &baz; | ||
| &qux; | ||
| }; | ||
| || { | ||
| // ^ move | ||
| // ^ ( | ||
| // ^ &mut baz | ||
| // ^ ) | ||
| &mut baz; | ||
| }; | ||
| // FIXME: &mut qux should be &unique qux | ||
| || { | ||
| // ^ move | ||
| // ^ ( | ||
| // ^ &mut baz | ||
| // ^ , | ||
| // ^ &mut qux | ||
| // ^ ) | ||
| baz = NonCopy; | ||
| *qux = NonCopy; | ||
| }; | ||
|
There was a problem hiding this comment. @HKalbasi fwiw I still think this is wrong. qux is not a mutable binding so we shouldn't be allowed to take a mutable borrow here. Do you mind pointing me to the part in the rustc code base for this (assuming you have it at hand)? There was a problem hiding this comment.
let mut t1 = 2;
let mut t2 = 5;
let mut x = &mut t1;
let mut y = || {
//&x;
*x = 3;
};
x = &mut t2;
y();compiles since There was a problem hiding this comment. I think it will becomes less confusing if we render the whole place. There was a problem hiding this comment. I think my confusion comes from thinking of old capture logic? Also the rust reference I suppose is outdated then. You are certainly right that we should be rendering the place we capture, as with this mere field captures will render incorrectly already I believe. There was a problem hiding this comment.
Yes the rust reference section for closure is pre edition-2021, and is currently in a misleading state. There was a problem hiding this comment. Turns out there is a PR for this already so I'll dig into that for now rust-lang/reference#1059 There was a problem hiding this comment. The new writing still refers to this as a unique immutable borrow fwiw https://github.com/sexxi-goose/reference/blob/closure-doc/src/types/closure.md#unique-immutable-borrows-in-captures |
||
| } | ||
| "#, | ||
| ); | ||
| } | ||
|
|
||
| #[test] | ||
| fn move_token() { | ||
| check_with_config( | ||
| InlayHintsConfig { closure_capture_hints: true, ..DISABLED_CONFIG }, | ||
| r#" | ||
| //- minicore: copy, derive | ||
| fn main() { | ||
| let foo = u32; | ||
| move || { | ||
| // ^^^^ ( | ||
| // ^^^^ foo | ||
| // ^^^^ ) | ||
| foo; | ||
| }; | ||
| } | ||
| "#, | ||
| ); | ||
| } | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.