1 use std::iter::successors;
4 use ide_db::RootDatabase;
6 algo::{self, skip_trivia_token},
7 ast::{self, AstNode, AstToken},
8 Direction, NodeOrToken,
10 SyntaxNode, SyntaxToken, TextRange, TextSize, TokenAtOffset, T,
15 // Feature: Expand and Shrink Selection
17 // Extends or shrinks the current selection to the encompassing syntactic construct
18 // (expression, statement, item, module, etc). It works with multiple cursors.
20 // This is a standard LSP feature and not a protocol extension.
23 // | Editor | Shortcut
25 // | VS Code | kbd:[Alt+Shift+→], kbd:[Alt+Shift+←]
27 pub(crate) fn extend_selection(db: &RootDatabase, frange: FileRange) -> TextRange {
28 let sema = Semantics::new(db);
29 let src = sema.parse(frange.file_id);
30 try_extend_selection(&sema, src.syntax(), frange).unwrap_or(frange.range)
33 fn try_extend_selection(
34 sema: &Semantics<RootDatabase>,
37 ) -> Option<TextRange> {
38 let range = frange.range;
40 let string_kinds = [COMMENT, STRING, BYTE_STRING];
42 RECORD_PAT_FIELD_LIST,
46 RECORD_EXPR_FIELD_LIST,
62 let offset = range.start();
63 let mut leaves = root.token_at_offset(offset);
64 if leaves.clone().all(|it| it.kind() == WHITESPACE) {
65 return Some(extend_ws(root, leaves.next()?, offset));
67 let leaf_range = match leaves {
68 TokenAtOffset::None => return None,
69 TokenAtOffset::Single(l) => {
70 if string_kinds.contains(&l.kind()) {
71 extend_single_word_in_comment_or_string(&l, offset)
72 .unwrap_or_else(|| l.text_range())
77 TokenAtOffset::Between(l, r) => pick_best(l, r).text_range(),
79 return Some(leaf_range);
81 let node = match root.covering_element(range) {
82 NodeOrToken::Token(token) => {
83 if token.text_range() != range {
84 return Some(token.text_range());
86 if let Some(comment) = ast::Comment::cast(token.clone()) {
87 if let Some(range) = extend_comments(comment) {
93 NodeOrToken::Node(node) => node,
96 // if we are in single token_tree, we maybe live in macro or attr
97 if node.kind() == TOKEN_TREE {
98 if let Some(macro_call) = node.ancestors().find_map(ast::MacroCall::cast) {
99 if let Some(range) = extend_tokens_from_range(sema, macro_call, range) {
105 if node.text_range() != range {
106 return Some(node.text_range());
109 let node = shallowest_node(&node);
111 if node.parent().map(|n| list_kinds.contains(&n.kind())) == Some(true) {
112 if let Some(range) = extend_list_item(&node) {
117 node.parent().map(|it| it.text_range())
120 fn extend_tokens_from_range(
121 sema: &Semantics<RootDatabase>,
122 macro_call: ast::MacroCall,
123 original_range: TextRange,
124 ) -> Option<TextRange> {
125 let src = macro_call.syntax().covering_element(original_range);
126 let (first_token, last_token) = match src {
127 NodeOrToken::Node(it) => (it.first_token()?, it.last_token()?),
128 NodeOrToken::Token(it) => (it.clone(), it),
131 let mut first_token = skip_trivia_token(first_token, Direction::Next)?;
132 let mut last_token = skip_trivia_token(last_token, Direction::Prev)?;
134 while !original_range.contains_range(first_token.text_range()) {
135 first_token = skip_trivia_token(first_token.next_token()?, Direction::Next)?;
137 while !original_range.contains_range(last_token.text_range()) {
138 last_token = skip_trivia_token(last_token.prev_token()?, Direction::Prev)?;
141 // compute original mapped token range
143 let fst_expanded = sema.descend_into_macros(first_token.clone());
144 let lst_expanded = sema.descend_into_macros(last_token.clone());
146 algo::least_common_ancestor(&fst_expanded.parent()?, &lst_expanded.parent()?)?;
147 lca = shallowest_node(&lca);
148 if lca.first_token() == Some(fst_expanded) && lca.last_token() == Some(lst_expanded) {
154 // Compute parent node range
155 let validate = |token: &SyntaxToken| -> bool {
156 let expanded = sema.descend_into_macros(token.clone());
157 let parent = match expanded.parent() {
159 None => return false,
161 algo::least_common_ancestor(&extended, &parent).as_ref() == Some(&extended)
164 // Find the first and last text range under expanded parent
165 let first = successors(Some(first_token), |token| {
166 let token = token.prev_token()?;
167 skip_trivia_token(token, Direction::Prev)
169 .take_while(validate)
172 let last = successors(Some(last_token), |token| {
173 let token = token.next_token()?;
174 skip_trivia_token(token, Direction::Next)
176 .take_while(validate)
179 let range = first.text_range().cover(last.text_range());
180 if range.contains_range(original_range) && original_range != range {
187 /// Find the shallowest node with same range, which allows us to traverse siblings.
188 fn shallowest_node(node: &SyntaxNode) -> SyntaxNode {
189 node.ancestors().take_while(|n| n.text_range() == node.text_range()).last().unwrap()
192 fn extend_single_word_in_comment_or_string(
195 ) -> Option<TextRange> {
196 let text: &str = leaf.text();
197 let cursor_position: u32 = (offset - leaf.text_range().start()).into();
199 let (before, after) = text.split_at(cursor_position as usize);
201 fn non_word_char(c: char) -> bool {
202 !(c.is_alphanumeric() || c == '_')
205 let start_idx = before.rfind(non_word_char)? as u32;
206 let end_idx = after.find(non_word_char).unwrap_or_else(|| after.len()) as u32;
208 let from: TextSize = (start_idx + 1).into();
209 let to: TextSize = (cursor_position + end_idx).into();
211 let range = TextRange::new(from, to);
212 if range.is_empty() {
215 Some(range + leaf.text_range().start())
219 fn extend_ws(root: &SyntaxNode, ws: SyntaxToken, offset: TextSize) -> TextRange {
220 let ws_text = ws.text();
221 let suffix = TextRange::new(offset, ws.text_range().end()) - ws.text_range().start();
222 let prefix = TextRange::new(ws.text_range().start(), offset) - ws.text_range().start();
223 let ws_suffix = &ws_text[suffix];
224 let ws_prefix = &ws_text[prefix];
225 if ws_text.contains('\n') && !ws_suffix.contains('\n') {
226 if let Some(node) = ws.next_sibling_or_token() {
227 let start = match ws_prefix.rfind('\n') {
228 Some(idx) => ws.text_range().start() + TextSize::from((idx + 1) as u32),
229 None => node.text_range().start(),
231 let end = if root.text().char_at(node.text_range().end()) == Some('\n') {
232 node.text_range().end() + TextSize::of('\n')
234 node.text_range().end()
236 return TextRange::new(start, end);
242 fn pick_best(l: SyntaxToken, r: SyntaxToken) -> SyntaxToken {
243 return if priority(&r) > priority(&l) { r } else { l };
244 fn priority(n: &SyntaxToken) -> usize {
247 IDENT | T![self] | T![super] | T![crate] | LIFETIME_IDENT => 2,
253 /// Extend list item selection to include nearby delimiter and whitespace.
254 fn extend_list_item(node: &SyntaxNode) -> Option<TextRange> {
255 fn is_single_line_ws(node: &SyntaxToken) -> bool {
256 node.kind() == WHITESPACE && !node.text().contains('\n')
260 delimiter_kind: SyntaxKind,
263 ) -> Option<SyntaxToken> {
264 node.siblings_with_tokens(dir)
266 .find(|node| match node {
267 NodeOrToken::Node(_) => true,
268 NodeOrToken::Token(it) => !is_single_line_ws(it),
270 .and_then(|it| it.into_token())
271 .filter(|node| node.kind() == delimiter_kind)
274 let delimiter = match node.kind() {
279 if let Some(delimiter_node) = nearby_delimiter(delimiter, node, Direction::Next) {
280 // Include any following whitespace when delimiter is after list item.
281 let final_node = delimiter_node
282 .next_sibling_or_token()
283 .and_then(|it| it.into_token())
284 .filter(|node| is_single_line_ws(node))
285 .unwrap_or(delimiter_node);
287 return Some(TextRange::new(node.text_range().start(), final_node.text_range().end()));
289 if let Some(delimiter_node) = nearby_delimiter(delimiter, node, Direction::Prev) {
290 return Some(TextRange::new(delimiter_node.text_range().start(), node.text_range().end()));
296 fn extend_comments(comment: ast::Comment) -> Option<TextRange> {
297 let prev = adj_comments(&comment, Direction::Prev);
298 let next = adj_comments(&comment, Direction::Next);
300 Some(TextRange::new(prev.syntax().text_range().start(), next.syntax().text_range().end()))
306 fn adj_comments(comment: &ast::Comment, dir: Direction) -> ast::Comment {
307 let mut res = comment.clone();
308 for element in comment.syntax().siblings_with_tokens(dir) {
309 let token = match element.as_token() {
311 Some(token) => token,
313 if let Some(c) = ast::Comment::cast(token.clone()) {
315 } else if token.kind() != WHITESPACE || token.text().contains("\n\n") {
328 fn do_check(before: &str, afters: &[&str]) {
329 let (analysis, position) = fixture::position(&before);
330 let before = analysis.file_text(position.file_id).unwrap();
331 let range = TextRange::empty(position.offset);
332 let mut frange = FileRange { file_id: position.file_id, range };
334 for &after in afters {
335 frange.range = analysis.extend_selection(frange).unwrap();
336 let actual = &before[frange.range];
337 assert_eq!(after, actual);
342 fn test_extend_selection_arith() {
343 do_check(r#"fn foo() { $01 + 1 }"#, &["1", "1 + 1", "{ 1 + 1 }"]);
347 fn test_extend_selection_list() {
348 do_check(r#"fn foo($0x: i32) {}"#, &["x", "x: i32"]);
349 do_check(r#"fn foo($0x: i32, y: i32) {}"#, &["x", "x: i32", "x: i32, "]);
350 do_check(r#"fn foo($0x: i32,y: i32) {}"#, &["x", "x: i32", "x: i32,", "(x: i32,y: i32)"]);
351 do_check(r#"fn foo(x: i32, $0y: i32) {}"#, &["y", "y: i32", ", y: i32"]);
352 do_check(r#"fn foo(x: i32, $0y: i32, ) {}"#, &["y", "y: i32", "y: i32, "]);
353 do_check(r#"fn foo(x: i32,$0y: i32) {}"#, &["y", "y: i32", ",y: i32"]);
355 do_check(r#"const FOO: [usize; 2] = [ 22$0 , 33];"#, &["22", "22 , "]);
356 do_check(r#"const FOO: [usize; 2] = [ 22 , 33$0];"#, &["33", ", 33"]);
357 do_check(r#"const FOO: [usize; 2] = [ 22 , 33$0 ,];"#, &["33", "33 ,", "[ 22 , 33 ,]"]);
359 do_check(r#"fn main() { (1, 2$0) }"#, &["2", ", 2", "(1, 2)"]);
363 const FOO: [usize; 2] = [
372 const FOO: [usize; 2] = [
381 fn test_extend_selection_start_of_the_line() {
389 &[" fn foo() {\n\n }\n"],
394 fn test_extend_selection_doc_comments() {
405 &["\n \n", "{\n \n}", "/// bla\n/// bla\nstruct B {\n \n}"],
410 fn test_extend_selection_comments() {
421 &["1", "// 1 + 1", "// fn foo() {\n// 1 + 1\n// }"],
426 // #[derive(Debug, Clone, Copy, PartialEq, Eq)]
427 // pub enum Direction {
434 "// #[derive(Debug, Clone, Copy, PartialEq, Eq)]\n// pub enum Direction {\n// Next,\n// Prev\n// }",
444 &["_bar1", "/*\nfoo\n_bar1*/"],
447 do_check(r#"//!$0foo_2 bar"#, &["foo_2", "//!foo_2 bar"]);
449 do_check(r#"/$0/foo bar"#, &["//foo bar"]);
453 fn test_extend_selection_prefer_idents() {
456 fn main() { foo$0+bar;}
462 fn main() { foo+$0bar;}
469 fn test_extend_selection_prefer_lifetimes() {
470 do_check(r#"fn foo<$0'a>() {}"#, &["'a", "<'a>"]);
471 do_check(r#"fn foo<'a$0>() {}"#, &["'a", "<'a>"]);
475 fn test_extend_selection_select_first_word() {
476 do_check(r#"// foo bar b$0az quxx"#, &["baz", "// foo bar baz quxx"]);
485 &["hello", "// hello world"],
490 fn test_extend_selection_string() {
497 &["foo", "\" fn foo() {\""],
502 fn test_extend_trait_bounds_list_in_where_clause() {
507 R: req::Request + 'static,
508 R::Params: DeserializeOwned$0 + panic::UnwindSafe + 'static,
509 R::Result: Serialize + 'static,
513 "DeserializeOwned + ",
514 "DeserializeOwned + panic::UnwindSafe + 'static",
515 "R::Params: DeserializeOwned + panic::UnwindSafe + 'static",
516 "R::Params: DeserializeOwned + panic::UnwindSafe + 'static,",
519 do_check(r#"fn foo<T>() where T: $0Copy"#, &["Copy"]);
520 do_check(r#"fn foo<T>() where T: $0Copy + Display"#, &["Copy", "Copy + "]);
521 do_check(r#"fn foo<T>() where T: $0Copy +Display"#, &["Copy", "Copy +"]);
522 do_check(r#"fn foo<T>() where T: $0Copy+Display"#, &["Copy", "Copy+"]);
523 do_check(r#"fn foo<T>() where T: Copy + $0Display"#, &["Display", "+ Display"]);
524 do_check(r#"fn foo<T>() where T: Copy + $0Display + Sync"#, &["Display", "Display + "]);
525 do_check(r#"fn foo<T>() where T: Copy +$0Display"#, &["Display", "+Display"]);
529 fn test_extend_trait_bounds_list_inline() {
530 do_check(r#"fn foo<T: $0Copy>() {}"#, &["Copy"]);
531 do_check(r#"fn foo<T: $0Copy + Display>() {}"#, &["Copy", "Copy + "]);
532 do_check(r#"fn foo<T: $0Copy +Display>() {}"#, &["Copy", "Copy +"]);
533 do_check(r#"fn foo<T: $0Copy+Display>() {}"#, &["Copy", "Copy+"]);
534 do_check(r#"fn foo<T: Copy + $0Display>() {}"#, &["Display", "+ Display"]);
535 do_check(r#"fn foo<T: Copy + $0Display + Sync>() {}"#, &["Display", "Display + "]);
536 do_check(r#"fn foo<T: Copy +$0Display>() {}"#, &["Display", "+Display"]);
538 r#"fn foo<T: Copy$0 + Display, U: Copy>() {}"#,
544 "T: Copy + Display, ",
545 "<T: Copy + Display, U: Copy>",
551 fn test_extend_selection_on_tuple_in_type() {
553 r#"fn main() { let _: (krate, $0_crate_def_map, module_id) = (); }"#,
554 &["_crate_def_map", "_crate_def_map, ", "(krate, _crate_def_map, module_id)"],
556 // white space variations
558 r#"fn main() { let _: (krate,$0_crate_def_map,module_id) = (); }"#,
559 &["_crate_def_map", "_crate_def_map,", "(krate,_crate_def_map,module_id)"],
571 "(\n krate,\n _crate_def_map,\n module_id\n)",
577 fn test_extend_selection_on_tuple_in_rvalue() {
579 r#"fn main() { let var = (krate, _crate_def_map$0, module_id); }"#,
580 &["_crate_def_map", "_crate_def_map, ", "(krate, _crate_def_map, module_id)"],
582 // white space variations
584 r#"fn main() { let var = (krate,_crate$0_def_map,module_id); }"#,
585 &["_crate_def_map", "_crate_def_map,", "(krate,_crate_def_map,module_id)"],
589 fn main() { let var = (
597 "(\n krate,\n _crate_def_map,\n module_id\n)",
603 fn test_extend_selection_on_tuple_pat() {
605 r#"fn main() { let (krate, _crate_def_map$0, module_id) = var; }"#,
606 &["_crate_def_map", "_crate_def_map, ", "(krate, _crate_def_map, module_id)"],
608 // white space variations
610 r#"fn main() { let (krate,_crate$0_def_map,module_id) = var; }"#,
611 &["_crate_def_map", "_crate_def_map,", "(krate,_crate_def_map,module_id)"],
623 "(\n krate,\n _crate_def_map,\n module_id\n)",
629 fn extend_selection_inside_macros() {
631 r#"macro_rules! foo { ($item:item) => {$item} }
632 foo!{fn hello(na$0me:usize){}}"#,
637 "fn hello(name:usize){}",
638 "{fn hello(name:usize){}}",
639 "foo!{fn hello(name:usize){}}",
645 fn extend_selection_inside_recur_macros() {
647 r#" macro_rules! foo2 { ($item:item) => {$item} }
648 macro_rules! foo { ($item:item) => {foo2!($item);} }
649 foo!{fn hello(na$0me:usize){}}"#,
654 "fn hello(name:usize){}",
655 "{fn hello(name:usize){}}",
656 "foo!{fn hello(name:usize){}}",