From 543f925353b3d80f5ab244b91d68efce009a02c2 Mon Sep 17 00:00:00 2001 From: Lukas Wirth Date: Thu, 24 Jun 2021 20:57:02 +0200 Subject: [PATCH] Highlight loop break points --- crates/ide/src/highlight_related.rs | 254 ++++++++++++++++++++++++++-- 1 file changed, 243 insertions(+), 11 deletions(-) diff --git a/crates/ide/src/highlight_related.rs b/crates/ide/src/highlight_related.rs index 1c17d351109..bc5e5eaebc5 100644 --- a/crates/ide/src/highlight_related.rs +++ b/crates/ide/src/highlight_related.rs @@ -24,6 +24,7 @@ pub struct HighlightedRange { // - if on an identifier, highlights all references to that identifier in the current file // - if on an `async` or `await token, highlights all yield points for that async context // - if on a `return` token, `?` character or `->` return type arrow, highlights all exit points for that context +// - if on a `break`, `loop`, `while` or `for` token, highlights all break points for that loop or block context pub(crate) fn highlight_related( sema: &Semantics, position: FilePosition, @@ -33,13 +34,21 @@ pub(crate) fn highlight_related( let token = pick_best_token(syntax.token_at_offset(position.offset), |kind| match kind { T![?] => 2, // prefer `?` when the cursor is sandwiched like `await$0?` - T![await] | T![async] | T![return] | T![->] => 1, + T![await] + | T![async] + | T![return] + | T![break] + | T![loop] + | T![for] + | T![while] + | T![->] => 1, _ => 0, })?; match token.kind() { T![return] | T![?] | T![->] => highlight_exit_points(sema, token), T![await] | T![async] => highlight_yield_points(token), + T![break] | T![loop] | T![for] | T![while] => highlight_break_points(token), _ => highlight_references(sema, &syntax, position), } } @@ -112,8 +121,13 @@ fn hl( if let Some(tail) = tail { for_each_inner_tail(&tail, &mut |tail| { - highlights - .push(HighlightedRange { access: None, range: tail.syntax().text_range() }) + let range = match tail { + ast::Expr::BreakExpr(b) => b + .break_token() + .map_or_else(|| tail.syntax().text_range(), |tok| tok.text_range()), + _ => tail.syntax().text_range(), + }; + highlights.push(HighlightedRange { access: None, range }) }); } Some(highlights) @@ -135,6 +149,65 @@ fn hl( None } +fn highlight_break_points(token: SyntaxToken) -> Option> { + fn hl( + token: Option, + label: Option, + body: Option, + ) -> Option> { + let mut highlights = Vec::new(); + let range = cover_range( + token.map(|tok| tok.text_range()), + label.as_ref().map(|it| it.syntax().text_range()), + ); + highlights.extend(range.map(|range| HighlightedRange { access: None, range })); + for_each_break(label, body, &mut |break_| { + let range = cover_range( + break_.break_token().map(|it| it.text_range()), + break_.lifetime().map(|it| it.syntax().text_range()), + ); + highlights.extend(range.map(|range| HighlightedRange { access: None, range })); + }); + Some(highlights) + } + let parent = token.parent()?; + let lbl = match_ast! { + match parent { + ast::BreakExpr(b) => b.lifetime(), + ast::LoopExpr(l) => l.label().and_then(|it| it.lifetime()), + ast::ForExpr(f) => f.label().and_then(|it| it.lifetime()), + ast::WhileExpr(w) => w.label().and_then(|it| it.lifetime()), + ast::EffectExpr(b) => Some(b.label().and_then(|it| it.lifetime())?), + _ => return None, + } + }; + let lbl = lbl.as_ref(); + let label_matches = |def_lbl: Option| match lbl { + Some(lbl) => { + Some(lbl.text()) == def_lbl.and_then(|it| it.lifetime()).as_ref().map(|it| it.text()) + } + None => true, + }; + for anc in token.ancestors().flat_map(ast::Expr::cast) { + return match anc { + ast::Expr::LoopExpr(l) if label_matches(l.label()) => { + hl(l.loop_token(), l.label(), l.loop_body()) + } + ast::Expr::ForExpr(f) if label_matches(f.label()) => { + hl(f.for_token(), f.label(), f.loop_body()) + } + ast::Expr::WhileExpr(w) if label_matches(w.label()) => { + hl(w.while_token(), w.label(), w.loop_body()) + } + ast::Expr::EffectExpr(e) if e.label().is_some() && label_matches(e.label()) => { + hl(None, e.label(), e.block_expr()) + } + _ => continue, + }; + } + None +} + fn highlight_yield_points(token: SyntaxToken) -> Option> { fn hl( async_token: Option, @@ -231,7 +304,9 @@ fn for_each_inner_tail(expr: &ast::Expr, cb: &mut dyn FnMut(&ast::Expr)) { ast::Expr::IfExpr(if_) => { if_.blocks().for_each(|block| for_each_inner_tail(&ast::Expr::BlockExpr(block), cb)) } - ast::Expr::LoopExpr(l) => for_each_break(l, cb), + ast::Expr::LoopExpr(l) => { + for_each_break(l.label(), l.loop_body(), &mut |b| cb(&ast::Expr::BreakExpr(b))) + } ast::Expr::MatchExpr(m) => { if let Some(arms) = m.match_arm_list() { arms.arms().filter_map(|arm| arm.expr()).for_each(|e| for_each_inner_tail(&e, cb)); @@ -267,10 +342,14 @@ fn for_each_inner_tail(expr: &ast::Expr, cb: &mut dyn FnMut(&ast::Expr)) { } } -fn for_each_break(l: &ast::LoopExpr, cb: &mut dyn FnMut(&ast::Expr)) { - let label = l.label().and_then(|lbl| lbl.lifetime()); +fn for_each_break( + label: Option, + body: Option, + cb: &mut dyn FnMut(ast::BreakExpr), +) { + let label = label.and_then(|lbl| lbl.lifetime()); let mut depth = 0; - if let Some(b) = l.loop_body() { + if let Some(b) = body { let preorder = &mut b.syntax().preorder(); let ev_as_expr = |ev| match ev { WalkEvent::Enter(it) => Some(WalkEvent::Enter(ast::Expr::cast(it)?)), @@ -281,13 +360,13 @@ fn for_each_break(l: &ast::LoopExpr, cb: &mut dyn FnMut(&ast::Expr)) { }; while let Some(node) = preorder.find_map(ev_as_expr) { match node { - WalkEvent::Enter(expr) => match &expr { + WalkEvent::Enter(expr) => match expr { ast::Expr::LoopExpr(_) | ast::Expr::WhileExpr(_) | ast::Expr::ForExpr(_) => { depth += 1 } ast::Expr::EffectExpr(e) if e.label().is_some() => depth += 1, ast::Expr::BreakExpr(b) if depth == 0 || eq_label(b.lifetime()) => { - cb(&expr); + cb(b); } _ => (), }, @@ -303,6 +382,15 @@ fn for_each_break(l: &ast::LoopExpr, cb: &mut dyn FnMut(&ast::Expr)) { } } +fn cover_range(r0: Option, r1: Option) -> Option { + match (r0, r1) { + (Some(r0), Some(r1)) => Some(r0.cover(r1)), + (Some(range), None) => Some(range), + (None, Some(range)) => Some(range), + (None, None) => None, + } +} + #[cfg(test)] mod tests { use crate::fixture; @@ -564,12 +652,12 @@ fn foo() ->$0 u32 { // ^^^ 7 => loop { break 5; - // ^^^^^^^ + // ^^^^^ } 8 => 'a: loop { 'b: loop { break 'a 5; - // ^^^^^^^^^^ + // ^^^^^ break 'b 5; break 5; }; @@ -580,6 +668,150 @@ fn foo() ->$0 u32 { } } } +"#, + ); + } + + #[test] + fn test_hl_break_loop() { + check( + r#" +fn foo() { + 'outer: loop { + // ^^^^^^^^^^^^ + break; + // ^^^^^ + 'inner: loop { + break; + 'innermost: loop { + break 'outer; + // ^^^^^^^^^^^^ + break 'inner; + } + break$0 'outer; + // ^^^^^^^^^^^^ + break; + } + break; + // ^^^^^ + } +} +"#, + ); + } + + #[test] + fn test_hl_break_for() { + check( + r#" +fn foo() { + 'outer: for _ in () { + // ^^^^^^^^^^^ + break; + // ^^^^^ + 'inner: for _ in () { + break; + 'innermost: for _ in () { + break 'outer; + // ^^^^^^^^^^^^ + break 'inner; + } + break$0 'outer; + // ^^^^^^^^^^^^ + break; + } + break; + // ^^^^^ + } +} +"#, + ); + } + + #[test] + fn test_hl_break_while() { + check( + r#" +fn foo() { + 'outer: while true { + // ^^^^^^^^^^^^^ + break; + // ^^^^^ + 'inner: while true { + break; + 'innermost: while true { + break 'outer; + // ^^^^^^^^^^^^ + break 'inner; + } + break$0 'outer; + // ^^^^^^^^^^^^ + break; + } + break; + // ^^^^^ + } +} +"#, + ); + } + + #[test] + fn test_hl_break_labeled_block() { + check( + r#" +fn foo() { + 'outer: { + // ^^^^^^^ + break; + // ^^^^^ + 'inner: { + break; + 'innermost: { + break 'outer; + // ^^^^^^^^^^^^ + break 'inner; + } + break$0 'outer; + // ^^^^^^^^^^^^ + break; + } + break; + // ^^^^^ + } +} +"#, + ); + } + + #[test] + fn test_hl_break_unlabeled_loop() { + check( + r#" +fn foo() { + loop { + // ^^^^ + break$0; + // ^^^^^ + } +} +"#, + ); + } + + #[test] + fn test_hl_break_unlabeled_block_in_loop() { + check( + r#" +fn foo() { + loop { + // ^^^^ + { + break$0; + // ^^^^^ + } + } +} "#, ); }