1 use std::iter::successors;
4 use ide_db::RootDatabase;
6 algo::{self, find_covering_element, skip_trivia_token},
7 ast::{self, AstNode, AstToken},
8 Direction, NodeOrToken,
10 SyntaxNode, SyntaxToken, TextRange, TextSize, TokenAtOffset, T,
15 // Feature: Extend Selection
17 // Extends the current selection to the encompassing syntactic construct
18 // (expression, statement, item, module, etc). It works with multiple cursors.
21 // | Editor | Shortcut
23 // | VS Code | kbd:[Ctrl+Shift+→]
25 pub(crate) fn extend_selection(db: &RootDatabase, frange: FileRange) -> TextRange {
26 let sema = Semantics::new(db);
27 let src = sema.parse(frange.file_id);
28 try_extend_selection(&sema, src.syntax(), frange).unwrap_or(frange.range)
31 fn try_extend_selection(
32 sema: &Semantics<RootDatabase>,
35 ) -> Option<TextRange> {
36 let range = frange.range;
38 let string_kinds = [COMMENT, STRING, RAW_STRING, BYTE_STRING, RAW_BYTE_STRING];
40 RECORD_PAT_FIELD_LIST,
44 RECORD_EXPR_FIELD_LIST,
60 let offset = range.start();
61 let mut leaves = root.token_at_offset(offset);
62 if leaves.clone().all(|it| it.kind() == WHITESPACE) {
63 return Some(extend_ws(root, leaves.next()?, offset));
65 let leaf_range = match leaves {
66 TokenAtOffset::None => return None,
67 TokenAtOffset::Single(l) => {
68 if string_kinds.contains(&l.kind()) {
69 extend_single_word_in_comment_or_string(&l, offset)
70 .unwrap_or_else(|| l.text_range())
75 TokenAtOffset::Between(l, r) => pick_best(l, r).text_range(),
77 return Some(leaf_range);
79 let node = match find_covering_element(root, range) {
80 NodeOrToken::Token(token) => {
81 if token.text_range() != range {
82 return Some(token.text_range());
84 if let Some(comment) = ast::Comment::cast(token.clone()) {
85 if let Some(range) = extend_comments(comment) {
91 NodeOrToken::Node(node) => node,
94 // if we are in single token_tree, we maybe live in macro or attr
95 if node.kind() == TOKEN_TREE {
96 if let Some(macro_call) = node.ancestors().find_map(ast::MacroCall::cast) {
97 if let Some(range) = extend_tokens_from_range(sema, macro_call, range) {
103 if node.text_range() != range {
104 return Some(node.text_range());
107 let node = shallowest_node(&node);
109 if node.parent().map(|n| list_kinds.contains(&n.kind())) == Some(true) {
110 if let Some(range) = extend_list_item(&node) {
115 node.parent().map(|it| it.text_range())
118 fn extend_tokens_from_range(
119 sema: &Semantics<RootDatabase>,
120 macro_call: ast::MacroCall,
121 original_range: TextRange,
122 ) -> Option<TextRange> {
123 let src = find_covering_element(¯o_call.syntax(), original_range);
124 let (first_token, last_token) = match src {
125 NodeOrToken::Node(it) => (it.first_token()?, it.last_token()?),
126 NodeOrToken::Token(it) => (it.clone(), it),
129 let mut first_token = skip_trivia_token(first_token, Direction::Next)?;
130 let mut last_token = skip_trivia_token(last_token, Direction::Prev)?;
132 while !original_range.contains_range(first_token.text_range()) {
133 first_token = skip_trivia_token(first_token.next_token()?, Direction::Next)?;
135 while !original_range.contains_range(last_token.text_range()) {
136 last_token = skip_trivia_token(last_token.prev_token()?, Direction::Prev)?;
139 // compute original mapped token range
141 let fst_expanded = sema.descend_into_macros(first_token.clone());
142 let lst_expanded = sema.descend_into_macros(last_token.clone());
143 let mut lca = algo::least_common_ancestor(&fst_expanded.parent(), &lst_expanded.parent())?;
144 lca = shallowest_node(&lca);
145 if lca.first_token() == Some(fst_expanded) && lca.last_token() == Some(lst_expanded) {
151 // Compute parent node range
152 let validate = |token: &SyntaxToken| {
153 let expanded = sema.descend_into_macros(token.clone());
154 algo::least_common_ancestor(&extended, &expanded.parent()).as_ref() == Some(&extended)
157 // Find the first and last text range under expanded parent
158 let first = successors(Some(first_token), |token| {
159 let token = token.prev_token()?;
160 skip_trivia_token(token, Direction::Prev)
162 .take_while(validate)
165 let last = successors(Some(last_token), |token| {
166 let token = token.next_token()?;
167 skip_trivia_token(token, Direction::Next)
169 .take_while(validate)
172 let range = first.text_range().cover(last.text_range());
173 if range.contains_range(original_range) && original_range != range {
180 /// Find the shallowest node with same range, which allows us to traverse siblings.
181 fn shallowest_node(node: &SyntaxNode) -> SyntaxNode {
182 node.ancestors().take_while(|n| n.text_range() == node.text_range()).last().unwrap()
185 fn extend_single_word_in_comment_or_string(
188 ) -> Option<TextRange> {
189 let text: &str = leaf.text();
190 let cursor_position: u32 = (offset - leaf.text_range().start()).into();
192 let (before, after) = text.split_at(cursor_position as usize);
194 fn non_word_char(c: char) -> bool {
195 !(c.is_alphanumeric() || c == '_')
198 let start_idx = before.rfind(non_word_char)? as u32;
199 let end_idx = after.find(non_word_char).unwrap_or_else(|| after.len()) as u32;
201 let from: TextSize = (start_idx + 1).into();
202 let to: TextSize = (cursor_position + end_idx).into();
204 let range = TextRange::new(from, to);
205 if range.is_empty() {
208 Some(range + leaf.text_range().start())
212 fn extend_ws(root: &SyntaxNode, ws: SyntaxToken, offset: TextSize) -> TextRange {
213 let ws_text = ws.text();
214 let suffix = TextRange::new(offset, ws.text_range().end()) - ws.text_range().start();
215 let prefix = TextRange::new(ws.text_range().start(), offset) - ws.text_range().start();
216 let ws_suffix = &ws_text.as_str()[suffix];
217 let ws_prefix = &ws_text.as_str()[prefix];
218 if ws_text.contains('\n') && !ws_suffix.contains('\n') {
219 if let Some(node) = ws.next_sibling_or_token() {
220 let start = match ws_prefix.rfind('\n') {
221 Some(idx) => ws.text_range().start() + TextSize::from((idx + 1) as u32),
222 None => node.text_range().start(),
224 let end = if root.text().char_at(node.text_range().end()) == Some('\n') {
225 node.text_range().end() + TextSize::of('\n')
227 node.text_range().end()
229 return TextRange::new(start, end);
235 fn pick_best(l: SyntaxToken, r: SyntaxToken) -> SyntaxToken {
236 return if priority(&r) > priority(&l) { r } else { l };
237 fn priority(n: &SyntaxToken) -> usize {
240 IDENT | T![self] | T![super] | T![crate] | LIFETIME => 2,
246 /// Extend list item selection to include nearby delimiter and whitespace.
247 fn extend_list_item(node: &SyntaxNode) -> Option<TextRange> {
248 fn is_single_line_ws(node: &SyntaxToken) -> bool {
249 node.kind() == WHITESPACE && !node.text().contains('\n')
253 delimiter_kind: SyntaxKind,
256 ) -> Option<SyntaxToken> {
257 node.siblings_with_tokens(dir)
259 .skip_while(|node| match node {
260 NodeOrToken::Node(_) => false,
261 NodeOrToken::Token(it) => is_single_line_ws(it),
264 .and_then(|it| it.into_token())
265 .filter(|node| node.kind() == delimiter_kind)
268 let delimiter = match node.kind() {
273 if let Some(delimiter_node) = nearby_delimiter(delimiter, node, Direction::Next) {
274 // Include any following whitespace when delimiter is after list item.
275 let final_node = delimiter_node
276 .next_sibling_or_token()
277 .and_then(|it| it.into_token())
278 .filter(|node| is_single_line_ws(node))
279 .unwrap_or(delimiter_node);
281 return Some(TextRange::new(node.text_range().start(), final_node.text_range().end()));
283 if let Some(delimiter_node) = nearby_delimiter(delimiter, node, Direction::Prev) {
284 return Some(TextRange::new(delimiter_node.text_range().start(), node.text_range().end()));
290 fn extend_comments(comment: ast::Comment) -> Option<TextRange> {
291 let prev = adj_comments(&comment, Direction::Prev);
292 let next = adj_comments(&comment, Direction::Next);
294 Some(TextRange::new(prev.syntax().text_range().start(), next.syntax().text_range().end()))
300 fn adj_comments(comment: &ast::Comment, dir: Direction) -> ast::Comment {
301 let mut res = comment.clone();
302 for element in comment.syntax().siblings_with_tokens(dir) {
303 let token = match element.as_token() {
305 Some(token) => token,
307 if let Some(c) = ast::Comment::cast(token.clone()) {
309 } else if token.kind() != WHITESPACE || token.text().contains("\n\n") {
322 fn do_check(before: &str, afters: &[&str]) {
323 let (analysis, position) = fixture::position(&before);
324 let before = analysis.file_text(position.file_id).unwrap();
325 let range = TextRange::empty(position.offset);
326 let mut frange = FileRange { file_id: position.file_id, range };
328 for &after in afters {
329 frange.range = analysis.extend_selection(frange).unwrap();
330 let actual = &before[frange.range];
331 assert_eq!(after, actual);
336 fn test_extend_selection_arith() {
337 do_check(r#"fn foo() { <|>1 + 1 }"#, &["1", "1 + 1", "{ 1 + 1 }"]);
341 fn test_extend_selection_list() {
342 do_check(r#"fn foo(<|>x: i32) {}"#, &["x", "x: i32"]);
343 do_check(r#"fn foo(<|>x: i32, y: i32) {}"#, &["x", "x: i32", "x: i32, "]);
344 do_check(r#"fn foo(<|>x: i32,y: i32) {}"#, &["x", "x: i32", "x: i32,", "(x: i32,y: i32)"]);
345 do_check(r#"fn foo(x: i32, <|>y: i32) {}"#, &["y", "y: i32", ", y: i32"]);
346 do_check(r#"fn foo(x: i32, <|>y: i32, ) {}"#, &["y", "y: i32", "y: i32, "]);
347 do_check(r#"fn foo(x: i32,<|>y: i32) {}"#, &["y", "y: i32", ",y: i32"]);
349 do_check(r#"const FOO: [usize; 2] = [ 22<|> , 33];"#, &["22", "22 , "]);
350 do_check(r#"const FOO: [usize; 2] = [ 22 , 33<|>];"#, &["33", ", 33"]);
351 do_check(r#"const FOO: [usize; 2] = [ 22 , 33<|> ,];"#, &["33", "33 ,", "[ 22 , 33 ,]"]);
353 do_check(r#"fn main() { (1, 2<|>) }"#, &["2", ", 2", "(1, 2)"]);
357 const FOO: [usize; 2] = [
366 const FOO: [usize; 2] = [
375 fn test_extend_selection_start_of_the_line() {
383 &[" fn foo() {\n\n }\n"],
388 fn test_extend_selection_doc_comments() {
399 &["\n \n", "{\n \n}", "/// bla\n/// bla\nstruct B {\n \n}"],
404 fn test_extend_selection_comments() {
415 &["1", "// 1 + 1", "// fn foo() {\n// 1 + 1\n// }"],
420 // #[derive(Debug, Clone, Copy, PartialEq, Eq)]
421 // pub enum Direction {
428 "// #[derive(Debug, Clone, Copy, PartialEq, Eq)]\n// pub enum Direction {\n// Next,\n// Prev\n// }",
438 &["_bar1", "/*\nfoo\n_bar1*/"],
441 do_check(r#"//!<|>foo_2 bar"#, &["foo_2", "//!foo_2 bar"]);
443 do_check(r#"/<|>/foo bar"#, &["//foo bar"]);
447 fn test_extend_selection_prefer_idents() {
450 fn main() { foo<|>+bar;}
456 fn main() { foo+<|>bar;}
463 fn test_extend_selection_prefer_lifetimes() {
464 do_check(r#"fn foo<<|>'a>() {}"#, &["'a", "<'a>"]);
465 do_check(r#"fn foo<'a<|>>() {}"#, &["'a", "<'a>"]);
469 fn test_extend_selection_select_first_word() {
470 do_check(r#"// foo bar b<|>az quxx"#, &["baz", "// foo bar baz quxx"]);
479 &["hello", "// hello world"],
484 fn test_extend_selection_string() {
491 &["foo", "\" fn foo() {\""],
496 fn test_extend_trait_bounds_list_in_where_clause() {
501 R: req::Request + 'static,
502 R::Params: DeserializeOwned<|> + panic::UnwindSafe + 'static,
503 R::Result: Serialize + 'static,
507 "DeserializeOwned + ",
508 "DeserializeOwned + panic::UnwindSafe + 'static",
509 "R::Params: DeserializeOwned + panic::UnwindSafe + 'static",
510 "R::Params: DeserializeOwned + panic::UnwindSafe + 'static,",
513 do_check(r#"fn foo<T>() where T: <|>Copy"#, &["Copy"]);
514 do_check(r#"fn foo<T>() where T: <|>Copy + Display"#, &["Copy", "Copy + "]);
515 do_check(r#"fn foo<T>() where T: <|>Copy +Display"#, &["Copy", "Copy +"]);
516 do_check(r#"fn foo<T>() where T: <|>Copy+Display"#, &["Copy", "Copy+"]);
517 do_check(r#"fn foo<T>() where T: Copy + <|>Display"#, &["Display", "+ Display"]);
518 do_check(r#"fn foo<T>() where T: Copy + <|>Display + Sync"#, &["Display", "Display + "]);
519 do_check(r#"fn foo<T>() where T: Copy +<|>Display"#, &["Display", "+Display"]);
523 fn test_extend_trait_bounds_list_inline() {
524 do_check(r#"fn foo<T: <|>Copy>() {}"#, &["Copy"]);
525 do_check(r#"fn foo<T: <|>Copy + Display>() {}"#, &["Copy", "Copy + "]);
526 do_check(r#"fn foo<T: <|>Copy +Display>() {}"#, &["Copy", "Copy +"]);
527 do_check(r#"fn foo<T: <|>Copy+Display>() {}"#, &["Copy", "Copy+"]);
528 do_check(r#"fn foo<T: Copy + <|>Display>() {}"#, &["Display", "+ Display"]);
529 do_check(r#"fn foo<T: Copy + <|>Display + Sync>() {}"#, &["Display", "Display + "]);
530 do_check(r#"fn foo<T: Copy +<|>Display>() {}"#, &["Display", "+Display"]);
532 r#"fn foo<T: Copy<|> + Display, U: Copy>() {}"#,
538 "T: Copy + Display, ",
539 "<T: Copy + Display, U: Copy>",
545 fn test_extend_selection_on_tuple_in_type() {
547 r#"fn main() { let _: (krate, <|>_crate_def_map, module_id) = (); }"#,
548 &["_crate_def_map", "_crate_def_map, ", "(krate, _crate_def_map, module_id)"],
550 // white space variations
552 r#"fn main() { let _: (krate,<|>_crate_def_map,module_id) = (); }"#,
553 &["_crate_def_map", "_crate_def_map,", "(krate,_crate_def_map,module_id)"],
565 "(\n krate,\n _crate_def_map,\n module_id\n)",
571 fn test_extend_selection_on_tuple_in_rvalue() {
573 r#"fn main() { let var = (krate, _crate_def_map<|>, module_id); }"#,
574 &["_crate_def_map", "_crate_def_map, ", "(krate, _crate_def_map, module_id)"],
576 // white space variations
578 r#"fn main() { let var = (krate,_crate<|>_def_map,module_id); }"#,
579 &["_crate_def_map", "_crate_def_map,", "(krate,_crate_def_map,module_id)"],
583 fn main() { let var = (
591 "(\n krate,\n _crate_def_map,\n module_id\n)",
597 fn test_extend_selection_on_tuple_pat() {
599 r#"fn main() { let (krate, _crate_def_map<|>, module_id) = var; }"#,
600 &["_crate_def_map", "_crate_def_map, ", "(krate, _crate_def_map, module_id)"],
602 // white space variations
604 r#"fn main() { let (krate,_crate<|>_def_map,module_id) = var; }"#,
605 &["_crate_def_map", "_crate_def_map,", "(krate,_crate_def_map,module_id)"],
617 "(\n krate,\n _crate_def_map,\n module_id\n)",
623 fn extend_selection_inside_macros() {
625 r#"macro_rules! foo { ($item:item) => {$item} }
626 foo!{fn hello(na<|>me:usize){}}"#,
631 "fn hello(name:usize){}",
632 "{fn hello(name:usize){}}",
633 "foo!{fn hello(name:usize){}}",
639 fn extend_selection_inside_recur_macros() {
641 r#" macro_rules! foo2 { ($item:item) => {$item} }
642 macro_rules! foo { ($item:item) => {foo2!($item);} }
643 foo!{fn hello(na<|>me:usize){}}"#,
648 "fn hello(name:usize){}",
649 "{fn hello(name:usize){}}",
650 "foo!{fn hello(name:usize){}}",