crates/ide_completion/src/patterns.rs

   1 //! Patterns telling us certain facts about current syntax element, they are used in completion context
   2 //!
   3 //! Most logic in this module first expands the token below the cursor to a maximum node that acts similar to the token itself.
   4 //! This means we for example expand a NameRef token to its outermost Path node, as semantically these act in the same location
   5 //! and the completions usually query for path specific things on the Path context instead. This simplifies some location handling.
   6
   7 use hir::Semantics;
   8 use ide_db::RootDatabase;
   9 use syntax::{
  10     algo::non_trivia_sibling,
  11     ast::{self, ArgListOwner, LoopBodyOwner},
  12     match_ast, AstNode, Direction, SyntaxElement,
  13     SyntaxKind::*,
  14     SyntaxNode, SyntaxToken, TextRange, TextSize, T,
  15 };
  16
  17 #[cfg(test)]
  18 use crate::tests::{check_pattern_is_applicable, check_pattern_is_not_applicable};
  19
  20 /// Immediate previous node to what we are completing.
  21 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
  22 pub(crate) enum ImmediatePrevSibling {
  23     IfExpr,
  24     TraitDefName,
  25     ImplDefType,
  26     Visibility,
  27     Attribute,
  28 }
  29
  30 /// Direct parent "thing" of what we are currently completing.
  31 #[derive(Clone, Debug, PartialEq, Eq)]
  32 pub(crate) enum ImmediateLocation {
  33     Use,
  34     UseTree,
  35     Impl,
  36     Trait,
  37     RecordField,
  38     TupleField,
  39     RefExpr,
  40     IdentPat,
  41     BlockExpr,
  42     ItemList,
  43     TypeBound,
  44     // Fake file ast node
  45     Attribute(ast::Attr),
  46     // Fake file ast node
  47     ModDeclaration(ast::Module),
  48     Visibility(ast::Visibility),
  49     // Original file ast node
  50     MethodCall {
  51         receiver: Option<ast::Expr>,
  52         has_parens: bool,
  53     },
  54     // Original file ast node
  55     FieldAccess {
  56         receiver: Option<ast::Expr>,
  57         receiver_is_ambiguous_float_literal: bool,
  58     },
  59     // Original file ast node
  60     // Only set from a type arg
  61     GenericArgList(ast::GenericArgList),
  62     // Original file ast node
  63     /// The record expr of the field name we are completing
  64     RecordExpr(ast::RecordExpr),
  65     // Original file ast node
  66     /// The record pat of the field name we are completing
  67     RecordPat(ast::RecordPat),
  68 }
  69
  70 pub(crate) fn determine_prev_sibling(name_like: &ast::NameLike) -> Option<ImmediatePrevSibling> {
  71     let node = match name_like {
  72         ast::NameLike::NameRef(name_ref) => maximize_name_ref(name_ref),
  73         ast::NameLike::Name(n) => n.syntax().clone(),
  74         ast::NameLike::Lifetime(lt) => lt.syntax().clone(),
  75     };
  76     let node = match node.parent().and_then(ast::MacroCall::cast) {
  77         // When a path is being typed after the name of a trait/type of an impl it is being
  78         // parsed as a macro, so when the trait/impl has a block following it an we are between the
  79         // name and block the macro will attach the block to itself so maximizing fails to take
  80         // that into account
  81         // FIXME path expr and statement have a similar problem with attrs
  82         Some(call)
  83             if call.excl_token().is_none()
  84                 && call.token_tree().map_or(false, |t| t.l_curly_token().is_some())
  85                 && call.semicolon_token().is_none() =>
  86         {
  87             call.syntax().clone()
  88         }
  89         _ => node,
  90     };
  91     let prev_sibling = non_trivia_sibling(node.into(), Direction::Prev)?.into_node()?;
  92     if prev_sibling.kind() == ERROR {
  93         let prev_sibling = prev_sibling.first_child()?;
  94         let res = match_ast! {
  95             match prev_sibling {
  96                 // vis followed by random ident will always error the parser
  97                 ast::Visibility(_it) => ImmediatePrevSibling::Visibility,
  98                 _ => return None,
  99             }
 100         };
 101         return Some(res);
 102     }
 103     let res = match_ast! {
 104         match prev_sibling {
 105             ast::ExprStmt(it) => {
 106                 let node = it.expr().filter(|_| it.semicolon_token().is_none())?.syntax().clone();
 107                 match_ast! {
 108                     match node {
 109                         ast::IfExpr(_it) => ImmediatePrevSibling::IfExpr,
 110                         _ => return None,
 111                     }
 112                 }
 113             },
 114             ast::Trait(it) => if it.assoc_item_list().is_none() {
 115                     ImmediatePrevSibling::TraitDefName
 116                 } else {
 117                     return None
 118             },
 119             ast::Impl(it) => if it.assoc_item_list().is_none()
 120                 && (it.for_token().is_none() || it.self_ty().is_some()) {
 121                     ImmediatePrevSibling::ImplDefType
 122                 } else {
 123                     return None
 124             },
 125             ast::Attr(_it) => ImmediatePrevSibling::Attribute,
 126             _ => return None,
 127         }
 128     };
 129     Some(res)
 130 }
 131
 132 pub(crate) fn determine_location(
 133     sema: &Semantics<RootDatabase>,
 134     original_file: &SyntaxNode,
 135     offset: TextSize,
 136     name_like: &ast::NameLike,
 137 ) -> Option<ImmediateLocation> {
 138     let node = match name_like {
 139         ast::NameLike::NameRef(name_ref) => {
 140             if ast::RecordExprField::for_field_name(name_ref).is_some() {
 141                 return sema
 142                     .find_node_at_offset_with_macros(original_file, offset)
 143                     .map(ImmediateLocation::RecordExpr);
 144             }
 145             if ast::RecordPatField::for_field_name_ref(name_ref).is_some() {
 146                 return sema
 147                     .find_node_at_offset_with_macros(original_file, offset)
 148                     .map(ImmediateLocation::RecordPat);
 149             }
 150             maximize_name_ref(name_ref)
 151         }
 152         ast::NameLike::Name(name) => {
 153             if ast::RecordPatField::for_field_name(name).is_some() {
 154                 return sema
 155                     .find_node_at_offset_with_macros(original_file, offset)
 156                     .map(ImmediateLocation::RecordPat);
 157             }
 158             name.syntax().clone()
 159         }
 160         ast::NameLike::Lifetime(lt) => lt.syntax().clone(),
 161     };
 162
 163     match_ast! {
 164         match node {
 165             ast::TypeBoundList(_it) => return Some(ImmediateLocation::TypeBound),
 166             _ => (),
 167         }
 168     };
 169
 170     let parent = match node.parent() {
 171         Some(parent) => match ast::MacroCall::cast(parent.clone()) {
 172             // When a path is being typed in an (Assoc)ItemList the parser will always emit a macro_call.
 173             // This is usually fine as the node expansion code above already accounts for that with
 174             // the ancestors call, but there is one exception to this which is that when an attribute
 175             // precedes it the code above will not walk the Path to the parent MacroCall as their ranges differ.
 176             // FIXME path expr and statement have a similar problem
 177             Some(call)
 178                 if call.excl_token().is_none()
 179                     && call.token_tree().is_none()
 180                     && call.semicolon_token().is_none() =>
 181             {
 182                 call.syntax().parent()?
 183             }
 184             _ => parent,
 185         },
 186         // SourceFile
 187         None => {
 188             return match node.kind() {
 189                 MACRO_ITEMS | SOURCE_FILE => Some(ImmediateLocation::ItemList),
 190                 _ => None,
 191             }
 192         }
 193     };
 194
 195     let res = match_ast! {
 196         match parent {
 197             ast::IdentPat(_it) => ImmediateLocation::IdentPat,
 198             ast::Use(_it) => ImmediateLocation::Use,
 199             ast::UseTree(_it) => ImmediateLocation::UseTree,
 200             ast::UseTreeList(_it) => ImmediateLocation::UseTree,
 201             ast::BlockExpr(_it) => ImmediateLocation::BlockExpr,
 202             ast::SourceFile(_it) => ImmediateLocation::ItemList,
 203             ast::ItemList(_it) => ImmediateLocation::ItemList,
 204             ast::RefExpr(_it) => ImmediateLocation::RefExpr,
 205             ast::RecordField(it) => if it.ty().map_or(false, |it| it.syntax().text_range().contains(offset)) {
 206                 return None;
 207             } else {
 208                 ImmediateLocation::RecordField
 209             },
 210             ast::RecordExprFieldList(_it) => sema
 211                 .find_node_at_offset_with_macros(original_file, offset)
 212                 .map(ImmediateLocation::RecordExpr)?,
 213             ast::TupleField(_it) => ImmediateLocation::TupleField,
 214             ast::TupleFieldList(_it) => ImmediateLocation::TupleField,
 215             ast::TypeBound(_it) => ImmediateLocation::TypeBound,
 216             ast::TypeBoundList(_it) => ImmediateLocation::TypeBound,
 217             ast::AssocItemList(it) => match it.syntax().parent().map(|it| it.kind()) {
 218                 Some(IMPL) => ImmediateLocation::Impl,
 219                 Some(TRAIT) => ImmediateLocation::Trait,
 220                 _ => return None,
 221             },
 222             ast::GenericArgList(_it) => sema
 223                 .find_node_at_offset_with_macros(original_file, offset)
 224                 .map(ImmediateLocation::GenericArgList)?,
 225             ast::Module(it) => {
 226                 if it.item_list().is_none() {
 227                     ImmediateLocation::ModDeclaration(it)
 228                 } else {
 229                     return None;
 230                 }
 231             },
 232             ast::Attr(it) => ImmediateLocation::Attribute(it),
 233             ast::FieldExpr(it) => {
 234                 let receiver = it
 235                     .expr()
 236                     .map(|e| e.syntax().text_range())
 237                     .and_then(|r| find_node_with_range(original_file, r));
 238                 let receiver_is_ambiguous_float_literal = if let Some(ast::Expr::Literal(l)) = &receiver {
 239                     match l.kind() {
 240                         ast::LiteralKind::FloatNumber { .. } => l.token().text().ends_with('.'),
 241                         _ => false,
 242                     }
 243                 } else {
 244                     false
 245                 };
 246                 ImmediateLocation::FieldAccess {
 247                     receiver,
 248                     receiver_is_ambiguous_float_literal,
 249                 }
 250             },
 251             ast::MethodCallExpr(it) => ImmediateLocation::MethodCall {
 252                 receiver: it
 253                     .receiver()
 254                     .map(|e| e.syntax().text_range())
 255                     .and_then(|r| find_node_with_range(original_file, r)),
 256                 has_parens: it.arg_list().map_or(false, |it| it.l_paren_token().is_some())
 257             },
 258             ast::Visibility(it) => it.pub_token()
 259                 .and_then(|t| (t.text_range().end() < offset).then(|| ImmediateLocation::Visibility(it)))?,
 260             _ => return None,
 261         }
 262     };
 263     Some(res)
 264 }
 265
 266 fn maximize_name_ref(name_ref: &ast::NameRef) -> SyntaxNode {
 267     // Maximize a nameref to its enclosing path if its the last segment of said path
 268     if let Some(segment) = name_ref.syntax().parent().and_then(ast::PathSegment::cast) {
 269         let p = segment.parent_path();
 270         if p.parent_path().is_none() {
 271             if let Some(it) = p
 272                 .syntax()
 273                 .ancestors()
 274                 .take_while(|it| it.text_range() == p.syntax().text_range())
 275                 .last()
 276             {
 277                 return it;
 278             }
 279         }
 280     }
 281     name_ref.syntax().clone()
 282 }
 283
 284 fn find_node_with_range<N: AstNode>(syntax: &SyntaxNode, range: TextRange) -> Option<N> {
 285     syntax.covering_element(range).ancestors().find_map(N::cast)
 286 }
 287
 288 pub(crate) fn inside_impl_trait_block(element: SyntaxElement) -> bool {
 289     // Here we search `impl` keyword up through the all ancestors, unlike in `has_impl_parent`,
 290     // where we only check the first parent with different text range.
 291     element
 292         .ancestors()
 293         .find(|it| it.kind() == IMPL)
 294         .map(|it| ast::Impl::cast(it).unwrap())
 295         .map(|it| it.trait_().is_some())
 296         .unwrap_or(false)
 297 }
 298 #[test]
 299 fn test_inside_impl_trait_block() {
 300     check_pattern_is_applicable(r"impl Foo for Bar { f$0 }", inside_impl_trait_block);
 301     check_pattern_is_applicable(r"impl Foo for Bar { fn f$0 }", inside_impl_trait_block);
 302     check_pattern_is_not_applicable(r"impl A { f$0 }", inside_impl_trait_block);
 303     check_pattern_is_not_applicable(r"impl A { fn f$0 }", inside_impl_trait_block);
 304 }
 305
 306 pub(crate) fn previous_token(element: SyntaxElement) -> Option<SyntaxToken> {
 307     element.into_token().and_then(previous_non_trivia_token)
 308 }
 309
 310 /// Check if the token previous to the previous one is `for`.
 311 /// For example, `for _ i$0` => true.
 312 pub(crate) fn for_is_prev2(element: SyntaxElement) -> bool {
 313     element
 314         .into_token()
 315         .and_then(previous_non_trivia_token)
 316         .and_then(previous_non_trivia_token)
 317         .filter(|it| it.kind() == T![for])
 318         .is_some()
 319 }
 320 #[test]
 321 fn test_for_is_prev2() {
 322     check_pattern_is_applicable(r"for i i$0", for_is_prev2);
 323 }
 324
 325 pub(crate) fn is_in_loop_body(node: &SyntaxNode) -> bool {
 326     node.ancestors()
 327         .take_while(|it| it.kind() != FN && it.kind() != CLOSURE_EXPR)
 328         .find_map(|it| {
 329             let loop_body = match_ast! {
 330                 match it {
 331                     ast::ForExpr(it) => it.loop_body(),
 332                     ast::WhileExpr(it) => it.loop_body(),
 333                     ast::LoopExpr(it) => it.loop_body(),
 334                     _ => None,
 335                 }
 336             };
 337             loop_body.filter(|it| it.syntax().text_range().contains_range(node.text_range()))
 338         })
 339         .is_some()
 340 }
 341
 342 fn previous_non_trivia_token(token: SyntaxToken) -> Option<SyntaxToken> {
 343     let mut token = token.prev_token();
 344     while let Some(inner) = token.clone() {
 345         if !inner.kind().is_trivia() {
 346             return Some(inner);
 347         } else {
 348             token = inner.prev_token();
 349         }
 350     }
 351     None
 352 }
 353
 354 #[cfg(test)]
 355 mod tests {
 356     use syntax::algo::find_node_at_offset;
 357
 358     use crate::tests::position;
 359
 360     use super::*;
 361
 362     fn check_location(code: &str, loc: impl Into<Option<ImmediateLocation>>) {
 363         let (db, pos) = position(code);
 364
 365         let sema = Semantics::new(&db);
 366         let original_file = sema.parse(pos.file_id);
 367
 368         let name_like = find_node_at_offset(original_file.syntax(), pos.offset).unwrap();
 369         assert_eq!(
 370             determine_location(&sema, original_file.syntax(), pos.offset, &name_like),
 371             loc.into()
 372         );
 373     }
 374
 375     fn check_prev_sibling(code: &str, sibling: impl Into<Option<ImmediatePrevSibling>>) {
 376         check_pattern_is_applicable(code, |e| {
 377             let name = &e.parent().and_then(ast::NameLike::cast).expect("Expected a namelike");
 378             assert_eq!(determine_prev_sibling(name), sibling.into());
 379             true
 380         });
 381     }
 382
 383     #[test]
 384     fn test_trait_loc() {
 385         check_location(r"trait A { f$0 }", ImmediateLocation::Trait);
 386         check_location(r"trait A { #[attr] f$0 }", ImmediateLocation::Trait);
 387         check_location(r"trait A { f$0 fn f() {} }", ImmediateLocation::Trait);
 388         check_location(r"trait A { fn f() {} f$0 }", ImmediateLocation::Trait);
 389         check_location(r"trait A$0 {}", None);
 390         check_location(r"trait A { fn f$0 }", None);
 391     }
 392
 393     #[test]
 394     fn test_impl_loc() {
 395         check_location(r"impl A { f$0 }", ImmediateLocation::Impl);
 396         check_location(r"impl A { #[attr] f$0 }", ImmediateLocation::Impl);
 397         check_location(r"impl A { f$0 fn f() {} }", ImmediateLocation::Impl);
 398         check_location(r"impl A { fn f() {} f$0 }", ImmediateLocation::Impl);
 399         check_location(r"impl A$0 {}", None);
 400         check_location(r"impl A { fn f$0 }", None);
 401     }
 402
 403     #[test]
 404     fn test_use_loc() {
 405         check_location(r"use f$0", ImmediateLocation::Use);
 406         check_location(r"use f$0;", ImmediateLocation::Use);
 407         check_location(r"use f::{f$0}", ImmediateLocation::UseTree);
 408         check_location(r"use {f$0}", ImmediateLocation::UseTree);
 409     }
 410
 411     #[test]
 412     fn test_record_field_loc() {
 413         check_location(r"struct Foo { f$0 }", ImmediateLocation::RecordField);
 414         check_location(r"struct Foo { f$0 pub f: i32}", ImmediateLocation::RecordField);
 415         check_location(r"struct Foo { pub f: i32, f$0 }", ImmediateLocation::RecordField);
 416     }
 417
 418     #[test]
 419     fn test_block_expr_loc() {
 420         check_location(r"fn my_fn() { let a = 2; f$0 }", ImmediateLocation::BlockExpr);
 421         check_location(r"fn my_fn() { f$0 f }", ImmediateLocation::BlockExpr);
 422     }
 423
 424     #[test]
 425     fn test_ident_pat_loc() {
 426         check_location(r"fn my_fn(m$0) {}", ImmediateLocation::IdentPat);
 427         check_location(r"fn my_fn() { let m$0 }", ImmediateLocation::IdentPat);
 428         check_location(r"fn my_fn(&m$0) {}", ImmediateLocation::IdentPat);
 429         check_location(r"fn my_fn() { let &m$0 }", ImmediateLocation::IdentPat);
 430     }
 431
 432     #[test]
 433     fn test_ref_expr_loc() {
 434         check_location(r"fn my_fn() { let x = &m$0 foo; }", ImmediateLocation::RefExpr);
 435     }
 436
 437     #[test]
 438     fn test_item_list_loc() {
 439         check_location(r"i$0", ImmediateLocation::ItemList);
 440         check_location(r"#[attr] i$0", ImmediateLocation::ItemList);
 441         check_location(r"fn f() {} i$0", ImmediateLocation::ItemList);
 442         check_location(r"mod foo { f$0 }", ImmediateLocation::ItemList);
 443         check_location(r"mod foo { #[attr] f$0 }", ImmediateLocation::ItemList);
 444         check_location(r"mod foo { fn f() {} f$0 }", ImmediateLocation::ItemList);
 445         check_location(r"mod foo$0 {}", None);
 446     }
 447
 448     #[test]
 449     fn test_impl_prev_sibling() {
 450         check_prev_sibling(r"impl A w$0 ", ImmediatePrevSibling::ImplDefType);
 451         check_prev_sibling(r"impl A w$0 {}", ImmediatePrevSibling::ImplDefType);
 452         check_prev_sibling(r"impl A for A w$0 ", ImmediatePrevSibling::ImplDefType);
 453         check_prev_sibling(r"impl A for A w$0 {}", ImmediatePrevSibling::ImplDefType);
 454         check_prev_sibling(r"impl A for w$0 {}", None);
 455         check_prev_sibling(r"impl A for w$0", None);
 456     }
 457
 458     #[test]
 459     fn test_trait_prev_sibling() {
 460         check_prev_sibling(r"trait A w$0 ", ImmediatePrevSibling::TraitDefName);
 461         check_prev_sibling(r"trait A w$0 {}", ImmediatePrevSibling::TraitDefName);
 462     }
 463
 464     #[test]
 465     fn test_if_expr_prev_sibling() {
 466         check_prev_sibling(r"fn foo() { if true {} w$0", ImmediatePrevSibling::IfExpr);
 467         check_prev_sibling(r"fn foo() { if true {}; w$0", None);
 468     }
 469
 470     #[test]
 471     fn test_vis_prev_sibling() {
 472         check_prev_sibling(r"pub w$0", ImmediatePrevSibling::Visibility);
 473     }
 474
 475     #[test]
 476     fn test_attr_prev_sibling() {
 477         check_prev_sibling(r"#[attr] w$0", ImmediatePrevSibling::Attribute);
 478     }
 479 }