crates/ide_completion/src/context.rs

   1 //! See `CompletionContext` structure.
   2
   3 use base_db::SourceDatabaseExt;
   4 use hir::{Local, ScopeDef, Semantics, SemanticsScope, Type};
   5 use ide_db::{
   6     base_db::{FilePosition, SourceDatabase},
   7     call_info::ActiveParameter,
   8     RootDatabase,
   9 };
  10 use syntax::{
  11     algo::find_node_at_offset,
  12     ast::{self, NameOrNameRef, NameOwner},
  13     match_ast, AstNode, NodeOrToken,
  14     SyntaxKind::{self, *},
  15     SyntaxNode, SyntaxToken, TextRange, TextSize, T,
  16 };
  17 use text_edit::Indel;
  18
  19 use crate::{
  20     patterns::{
  21         determine_location, determine_prev_sibling, for_is_prev2, inside_impl_trait_block,
  22         is_in_loop_body, previous_token, ImmediateLocation, ImmediatePrevSibling,
  23     },
  24     CompletionConfig,
  25 };
  26
  27 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
  28 pub(crate) enum PatternRefutability {
  29     Refutable,
  30     Irrefutable,
  31 }
  32
  33 #[derive(Debug)]
  34 pub(super) enum PathKind {
  35     Expr,
  36     Type,
  37 }
  38
  39 #[derive(Debug)]
  40 pub(crate) struct PathCompletionContext {
  41     /// If this is a call with () already there
  42     call_kind: Option<CallKind>,
  43     /// A single-indent path, like `foo`. `::foo` should not be considered a trivial path.
  44     pub(super) is_trivial_path: bool,
  45     /// If not a trivial path, the prefix (qualifier).
  46     pub(super) qualifier: Option<ast::Path>,
  47     /// Whether the qualifier comes from a use tree parent or not
  48     pub(super) use_tree_parent: bool,
  49     pub(super) kind: Option<PathKind>,
  50     /// Whether the path segment has type args or not.
  51     pub(super) has_type_args: bool,
  52     /// `true` if we are a statement or a last expr in the block.
  53     pub(super) can_be_stmt: bool,
  54     pub(super) in_loop_body: bool,
  55 }
  56
  57 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
  58 pub(crate) enum CallKind {
  59     Pat,
  60     Mac,
  61     Expr,
  62 }
  63 /// `CompletionContext` is created early during completion to figure out, where
  64 /// exactly is the cursor, syntax-wise.
  65 #[derive(Debug)]
  66 pub(crate) struct CompletionContext<'a> {
  67     pub(super) sema: Semantics<'a, RootDatabase>,
  68     pub(super) scope: SemanticsScope<'a>,
  69     pub(super) db: &'a RootDatabase,
  70     pub(super) config: &'a CompletionConfig,
  71     pub(super) position: FilePosition,
  72     /// The token before the cursor, in the original file.
  73     pub(super) original_token: SyntaxToken,
  74     /// The token before the cursor, in the macro-expanded file.
  75     pub(super) token: SyntaxToken,
  76     pub(super) krate: Option<hir::Crate>,
  77     pub(super) expected_name: Option<NameOrNameRef>,
  78     pub(super) expected_type: Option<Type>,
  79
  80     /// The parent function of the cursor position if it exists.
  81     pub(super) function_def: Option<ast::Fn>,
  82     /// The parent impl of the cursor position if it exists.
  83     pub(super) impl_def: Option<ast::Impl>,
  84     pub(super) name_ref_syntax: Option<ast::NameRef>,
  85
  86     // potentially set if we are completing a lifetime
  87     pub(super) lifetime_syntax: Option<ast::Lifetime>,
  88     pub(super) lifetime_param_syntax: Option<ast::LifetimeParam>,
  89     pub(super) lifetime_allowed: bool,
  90     pub(super) is_label_ref: bool,
  91
  92     // potentially set if we are completing a name
  93     pub(super) is_pat_or_const: Option<PatternRefutability>,
  94     pub(super) is_param: bool,
  95
  96     pub(super) completion_location: Option<ImmediateLocation>,
  97     pub(super) prev_sibling: Option<ImmediatePrevSibling>,
  98     pub(super) attribute_under_caret: Option<ast::Attr>,
  99     pub(super) previous_token: Option<SyntaxToken>,
 100
 101     pub(super) path_context: Option<PathCompletionContext>,
 102     pub(super) active_parameter: Option<ActiveParameter>,
 103     pub(super) locals: Vec<(String, Local)>,
 104
 105     pub(super) incomplete_let: bool,
 106
 107     no_completion_required: bool,
 108 }
 109
 110 impl<'a> CompletionContext<'a> {
 111     pub(super) fn new(
 112         db: &'a RootDatabase,
 113         position: FilePosition,
 114         config: &'a CompletionConfig,
 115     ) -> Option<CompletionContext<'a>> {
 116         let sema = Semantics::new(db);
 117
 118         let original_file = sema.parse(position.file_id);
 119
 120         // Insert a fake ident to get a valid parse tree. We will use this file
 121         // to determine context, though the original_file will be used for
 122         // actual completion.
 123         let file_with_fake_ident = {
 124             let parse = db.parse(position.file_id);
 125             let edit = Indel::insert(position.offset, "intellijRulezz".to_string());
 126             parse.reparse(&edit).tree()
 127         };
 128         let fake_ident_token =
 129             file_with_fake_ident.syntax().token_at_offset(position.offset).right_biased().unwrap();
 130
 131         let krate = sema.to_module_def(position.file_id).map(|m| m.krate());
 132         let original_token =
 133             original_file.syntax().token_at_offset(position.offset).left_biased()?;
 134         let token = sema.descend_into_macros(original_token.clone());
 135         let scope = sema.scope_at_offset(&token, position.offset);
 136         let mut locals = vec![];
 137         scope.process_all_names(&mut |name, scope| {
 138             if let ScopeDef::Local(local) = scope {
 139                 locals.push((name.to_string(), local));
 140             }
 141         });
 142         let mut ctx = CompletionContext {
 143             sema,
 144             scope,
 145             db,
 146             config,
 147             position,
 148             original_token,
 149             token,
 150             krate,
 151             expected_name: None,
 152             expected_type: None,
 153             function_def: None,
 154             impl_def: None,
 155             name_ref_syntax: None,
 156             lifetime_syntax: None,
 157             lifetime_param_syntax: None,
 158             lifetime_allowed: false,
 159             is_label_ref: false,
 160             is_pat_or_const: None,
 161             is_param: false,
 162             completion_location: None,
 163             prev_sibling: None,
 164             attribute_under_caret: None,
 165             previous_token: None,
 166             path_context: None,
 167             active_parameter: ActiveParameter::at(db, position),
 168             locals,
 169             incomplete_let: false,
 170             no_completion_required: false,
 171         };
 172
 173         let mut original_file = original_file.syntax().clone();
 174         let mut speculative_file = file_with_fake_ident.syntax().clone();
 175         let mut offset = position.offset;
 176         let mut fake_ident_token = fake_ident_token;
 177
 178         // Are we inside a macro call?
 179         while let (Some(actual_macro_call), Some(macro_call_with_fake_ident)) = (
 180             find_node_at_offset::<ast::MacroCall>(&original_file, offset),
 181             find_node_at_offset::<ast::MacroCall>(&speculative_file, offset),
 182         ) {
 183             if actual_macro_call.path().as_ref().map(|s| s.syntax().text())
 184                 != macro_call_with_fake_ident.path().as_ref().map(|s| s.syntax().text())
 185             {
 186                 break;
 187             }
 188             let speculative_args = match macro_call_with_fake_ident.token_tree() {
 189                 Some(tt) => tt,
 190                 None => break,
 191             };
 192             if let (Some(actual_expansion), Some(speculative_expansion)) = (
 193                 ctx.sema.expand(&actual_macro_call),
 194                 ctx.sema.speculative_expand(
 195                     &actual_macro_call,
 196                     &speculative_args,
 197                     fake_ident_token,
 198                 ),
 199             ) {
 200                 let new_offset = speculative_expansion.1.text_range().start();
 201                 if new_offset > actual_expansion.text_range().end() {
 202                     break;
 203                 }
 204                 original_file = actual_expansion;
 205                 speculative_file = speculative_expansion.0;
 206                 fake_ident_token = speculative_expansion.1;
 207                 offset = new_offset;
 208             } else {
 209                 break;
 210             }
 211         }
 212         ctx.fill(&original_file, speculative_file, offset);
 213         Some(ctx)
 214     }
 215
 216     /// Checks whether completions in that particular case don't make much sense.
 217     /// Examples:
 218     /// - `fn $0` -- we expect function name, it's unlikely that "hint" will be helpful.
 219     ///   Exception for this case is `impl Trait for Foo`, where we would like to hint trait method names.
 220     /// - `for _ i$0` -- obviously, it'll be "in" keyword.
 221     pub(crate) fn no_completion_required(&self) -> bool {
 222         self.no_completion_required
 223     }
 224
 225     /// The range of the identifier that is being completed.
 226     pub(crate) fn source_range(&self) -> TextRange {
 227         // check kind of macro-expanded token, but use range of original token
 228         let kind = self.token.kind();
 229         if kind == IDENT || kind == LIFETIME_IDENT || kind == UNDERSCORE || kind.is_keyword() {
 230             cov_mark::hit!(completes_if_prefix_is_keyword);
 231             self.original_token.text_range()
 232         } else if kind == CHAR {
 233             // assume we are completing a lifetime but the user has only typed the '
 234             cov_mark::hit!(completes_if_lifetime_without_idents);
 235             TextRange::at(self.original_token.text_range().start(), TextSize::from(1))
 236         } else {
 237             TextRange::empty(self.position.offset)
 238         }
 239     }
 240
 241     pub(crate) fn previous_token_is(&self, kind: SyntaxKind) -> bool {
 242         self.previous_token.as_ref().map_or(false, |tok| tok.kind() == kind)
 243     }
 244
 245     pub(crate) fn expects_assoc_item(&self) -> bool {
 246         matches!(self.completion_location, Some(ImmediateLocation::Trait | ImmediateLocation::Impl))
 247     }
 248
 249     pub(crate) fn has_dot_receiver(&self) -> bool {
 250         matches!(
 251             &self.completion_location,
 252             Some(ImmediateLocation::FieldAccess { receiver, .. } | ImmediateLocation::MethodCall { receiver,.. })
 253                 if receiver.is_some()
 254         )
 255     }
 256
 257     pub(crate) fn dot_receiver(&self) -> Option<&ast::Expr> {
 258         match &self.completion_location {
 259             Some(
 260                 ImmediateLocation::MethodCall { receiver, .. }
 261                 | ImmediateLocation::FieldAccess { receiver, .. },
 262             ) => receiver.as_ref(),
 263             _ => None,
 264         }
 265     }
 266
 267     pub(crate) fn expects_non_trait_assoc_item(&self) -> bool {
 268         matches!(self.completion_location, Some(ImmediateLocation::Impl))
 269     }
 270
 271     pub(crate) fn expects_item(&self) -> bool {
 272         matches!(self.completion_location, Some(ImmediateLocation::ItemList))
 273     }
 274
 275     pub(crate) fn expects_generic_arg(&self) -> bool {
 276         matches!(self.completion_location, Some(ImmediateLocation::GenericArgList(_)))
 277     }
 278
 279     pub(crate) fn has_block_expr_parent(&self) -> bool {
 280         matches!(self.completion_location, Some(ImmediateLocation::BlockExpr))
 281     }
 282
 283     pub(crate) fn expects_ident_pat_or_ref_expr(&self) -> bool {
 284         matches!(
 285             self.completion_location,
 286             Some(ImmediateLocation::IdentPat | ImmediateLocation::RefExpr)
 287         )
 288     }
 289
 290     pub(crate) fn expect_field(&self) -> bool {
 291         matches!(
 292             self.completion_location,
 293             Some(ImmediateLocation::RecordField | ImmediateLocation::TupleField)
 294         )
 295     }
 296
 297     pub(crate) fn in_use_tree(&self) -> bool {
 298         matches!(
 299             self.completion_location,
 300             Some(ImmediateLocation::Use | ImmediateLocation::UseTree)
 301         )
 302     }
 303
 304     pub(crate) fn has_impl_or_trait_prev_sibling(&self) -> bool {
 305         matches!(
 306             self.prev_sibling,
 307             Some(ImmediatePrevSibling::ImplDefType | ImmediatePrevSibling::TraitDefName)
 308         )
 309     }
 310
 311     pub(crate) fn has_impl_prev_sibling(&self) -> bool {
 312         matches!(self.prev_sibling, Some(ImmediatePrevSibling::ImplDefType))
 313     }
 314
 315     pub(crate) fn has_visibility_prev_sibling(&self) -> bool {
 316         matches!(self.prev_sibling, Some(ImmediatePrevSibling::Visibility))
 317     }
 318
 319     pub(crate) fn after_if(&self) -> bool {
 320         matches!(self.prev_sibling, Some(ImmediatePrevSibling::IfExpr))
 321     }
 322
 323     pub(crate) fn is_path_disallowed(&self) -> bool {
 324         self.attribute_under_caret.is_some()
 325             || self.previous_token_is(T![unsafe])
 326             || matches!(
 327                 self.prev_sibling,
 328                 Some(ImmediatePrevSibling::Attribute | ImmediatePrevSibling::Visibility)
 329             )
 330             || matches!(
 331                 self.completion_location,
 332                 Some(
 333                     ImmediateLocation::Attribute(_)
 334                         | ImmediateLocation::ModDeclaration(_)
 335                         | ImmediateLocation::RecordPat(_)
 336                         | ImmediateLocation::RecordExpr(_)
 337                 )
 338             )
 339     }
 340
 341     pub(crate) fn expects_expression(&self) -> bool {
 342         matches!(self.path_context, Some(PathCompletionContext { kind: Some(PathKind::Expr), .. }))
 343     }
 344
 345     pub(crate) fn expects_type(&self) -> bool {
 346         matches!(self.path_context, Some(PathCompletionContext { kind: Some(PathKind::Type), .. }))
 347     }
 348
 349     pub(crate) fn path_call_kind(&self) -> Option<CallKind> {
 350         self.path_context.as_ref().and_then(|it| it.call_kind)
 351     }
 352
 353     pub(crate) fn is_trivial_path(&self) -> bool {
 354         matches!(self.path_context, Some(PathCompletionContext { is_trivial_path: true, .. }))
 355     }
 356
 357     pub(crate) fn is_non_trivial_path(&self) -> bool {
 358         matches!(self.path_context, Some(PathCompletionContext { is_trivial_path: false, .. }))
 359     }
 360
 361     pub(crate) fn path_qual(&self) -> Option<&ast::Path> {
 362         self.path_context.as_ref().and_then(|it| it.qualifier.as_ref())
 363     }
 364
 365     /// Checks if an item is visible and not `doc(hidden)` at the completion site.
 366     pub(crate) fn is_visible<I>(&self, item: &I) -> bool
 367     where
 368         I: hir::HasVisibility + hir::HasAttrs + hir::HasCrate + Copy,
 369     {
 370         self.is_visible_impl(&item.visibility(self.db), &item.attrs(self.db), item.krate(self.db))
 371     }
 372
 373     fn is_visible_impl(
 374         &self,
 375         vis: &hir::Visibility,
 376         attrs: &hir::Attrs,
 377         defining_crate: hir::Crate,
 378     ) -> bool {
 379         let module = match self.scope.module() {
 380             Some(it) => it,
 381             None => return false,
 382         };
 383         if !vis.is_visible_from(self.db, module.into()) {
 384             // If the definition location is editable, also show private items
 385             let root_file = defining_crate.root_file(self.db);
 386             let source_root_id = self.db.file_source_root(root_file);
 387             let is_editable = !self.db.source_root(source_root_id).is_library;
 388             return is_editable;
 389         }
 390
 391         if module.krate() != defining_crate && attrs.has_doc_hidden() {
 392             // `doc(hidden)` items are only completed within the defining crate.
 393             return false;
 394         }
 395
 396         true
 397     }
 398
 399     fn fill_impl_def(&mut self) {
 400         self.impl_def = self
 401             .sema
 402             .token_ancestors_with_macros(self.token.clone())
 403             .take_while(|it| it.kind() != SOURCE_FILE && it.kind() != MODULE)
 404             .find_map(ast::Impl::cast);
 405     }
 406
 407     fn expected_type_and_name(&self) -> (Option<Type>, Option<NameOrNameRef>) {
 408         let mut node = match self.token.parent() {
 409             Some(it) => it,
 410             None => return (None, None),
 411         };
 412         loop {
 413             break match_ast! {
 414                 match node {
 415                     ast::LetStmt(it) => {
 416                         cov_mark::hit!(expected_type_let_with_leading_char);
 417                         cov_mark::hit!(expected_type_let_without_leading_char);
 418                         let ty = it.pat()
 419                             .and_then(|pat| self.sema.type_of_pat(&pat))
 420                             .or_else(|| it.initializer().and_then(|it| self.sema.type_of_expr(&it)));
 421                         let name = if let Some(ast::Pat::IdentPat(ident)) = it.pat() {
 422                             ident.name().map(NameOrNameRef::Name)
 423                         } else {
 424                             None
 425                         };
 426
 427                         (ty, name)
 428                     },
 429                     ast::ArgList(_it) => {
 430                         cov_mark::hit!(expected_type_fn_param);
 431                         ActiveParameter::at_token(
 432                             &self.sema,
 433                             self.token.clone(),
 434                         ).map(|ap| {
 435                             let name = ap.ident().map(NameOrNameRef::Name);
 436                             let ty = if has_ref(&self.token) {
 437                                 cov_mark::hit!(expected_type_fn_param_ref);
 438                                 ap.ty.remove_ref()
 439                             } else {
 440                                 Some(ap.ty)
 441                             };
 442                             (ty, name)
 443                         })
 444                         .unwrap_or((None, None))
 445                     },
 446                     ast::RecordExprFieldList(_it) => {
 447                         cov_mark::hit!(expected_type_struct_field_without_leading_char);
 448                         // wouldn't try {} be nice...
 449                         (|| {
 450                             let expr_field = self.token.prev_sibling_or_token()?
 451                                       .into_node()
 452                                       .and_then(ast::RecordExprField::cast)?;
 453                             let (_, _, ty) = self.sema.resolve_record_field(&expr_field)?;
 454                             Some((
 455                                 Some(ty),
 456                                 expr_field.field_name().map(NameOrNameRef::NameRef),
 457                             ))
 458                         })().unwrap_or((None, None))
 459                     },
 460                     ast::RecordExprField(it) => {
 461                         cov_mark::hit!(expected_type_struct_field_with_leading_char);
 462                         (
 463                             it.expr().as_ref().and_then(|e| self.sema.type_of_expr(e)),
 464                             it.field_name().map(NameOrNameRef::NameRef),
 465                         )
 466                     },
 467                     ast::MatchExpr(it) => {
 468                         cov_mark::hit!(expected_type_match_arm_without_leading_char);
 469                         let ty = it.expr()
 470                             .and_then(|e| self.sema.type_of_expr(&e));
 471                         (ty, None)
 472                     },
 473                     ast::IfExpr(it) => {
 474                         cov_mark::hit!(expected_type_if_let_without_leading_char);
 475                         let ty = it.condition()
 476                             .and_then(|cond| cond.expr())
 477                             .and_then(|e| self.sema.type_of_expr(&e));
 478                         (ty, None)
 479                     },
 480                     ast::IdentPat(it) => {
 481                         cov_mark::hit!(expected_type_if_let_with_leading_char);
 482                         cov_mark::hit!(expected_type_match_arm_with_leading_char);
 483                         let ty = self.sema.type_of_pat(&ast::Pat::from(it));
 484                         (ty, None)
 485                     },
 486                     ast::Fn(it) => {
 487                         cov_mark::hit!(expected_type_fn_ret_with_leading_char);
 488                         cov_mark::hit!(expected_type_fn_ret_without_leading_char);
 489                         let def = self.sema.to_def(&it);
 490                         (def.map(|def| def.ret_type(self.db)), None)
 491                     },
 492                     ast::ClosureExpr(it) => {
 493                         let ty = self.sema.type_of_expr(&it.into());
 494                         ty.and_then(|ty| ty.as_callable(self.db))
 495                             .map(|c| (Some(c.return_type()), None))
 496                             .unwrap_or((None, None))
 497                     },
 498                     ast::Stmt(_it) => (None, None),
 499                     _ => {
 500                         match node.parent() {
 501                             Some(n) => {
 502                                 node = n;
 503                                 continue;
 504                             },
 505                             None => (None, None),
 506                         }
 507                     },
 508                 }
 509             };
 510         }
 511     }
 512
 513     fn fill(
 514         &mut self,
 515         original_file: &SyntaxNode,
 516         file_with_fake_ident: SyntaxNode,
 517         offset: TextSize,
 518     ) {
 519         let fake_ident_token = file_with_fake_ident.token_at_offset(offset).right_biased().unwrap();
 520         let syntax_element = NodeOrToken::Token(fake_ident_token);
 521         self.previous_token = previous_token(syntax_element.clone());
 522         self.attribute_under_caret = syntax_element.ancestors().find_map(ast::Attr::cast);
 523         self.no_completion_required = {
 524             let inside_impl_trait_block = inside_impl_trait_block(syntax_element.clone());
 525             let fn_is_prev = self.previous_token_is(T![fn]);
 526             let for_is_prev2 = for_is_prev2(syntax_element.clone());
 527             (fn_is_prev && !inside_impl_trait_block) || for_is_prev2
 528         };
 529
 530         self.incomplete_let =
 531             syntax_element.ancestors().take(6).find_map(ast::LetStmt::cast).map_or(false, |it| {
 532                 it.syntax().text_range().end() == syntax_element.text_range().end()
 533             });
 534
 535         let (expected_type, expected_name) = self.expected_type_and_name();
 536         self.expected_type = expected_type;
 537         self.expected_name = expected_name;
 538
 539         let name_like = match find_node_at_offset(&file_with_fake_ident, offset) {
 540             Some(it) => it,
 541             None => return,
 542         };
 543         self.completion_location =
 544             determine_location(&self.sema, original_file, offset, &name_like);
 545         self.prev_sibling = determine_prev_sibling(&name_like);
 546         match name_like {
 547             ast::NameLike::Lifetime(lifetime) => {
 548                 self.classify_lifetime(original_file, lifetime, offset);
 549             }
 550             ast::NameLike::NameRef(name_ref) => {
 551                 self.classify_name_ref(original_file, name_ref);
 552             }
 553             ast::NameLike::Name(name) => {
 554                 self.classify_name(name);
 555             }
 556         }
 557     }
 558
 559     fn classify_lifetime(
 560         &mut self,
 561         original_file: &SyntaxNode,
 562         lifetime: ast::Lifetime,
 563         offset: TextSize,
 564     ) {
 565         self.lifetime_syntax =
 566             find_node_at_offset(original_file, lifetime.syntax().text_range().start());
 567         if let Some(parent) = lifetime.syntax().parent() {
 568             if parent.kind() == ERROR {
 569                 return;
 570             }
 571
 572             match_ast! {
 573                 match parent {
 574                     ast::LifetimeParam(_it) => {
 575                         self.lifetime_allowed = true;
 576                         self.lifetime_param_syntax =
 577                             self.sema.find_node_at_offset_with_macros(original_file, offset);
 578                     },
 579                     ast::BreakExpr(_it) => self.is_label_ref = true,
 580                     ast::ContinueExpr(_it) => self.is_label_ref = true,
 581                     ast::Label(_it) => (),
 582                     _ => self.lifetime_allowed = true,
 583                 }
 584             }
 585         }
 586     }
 587
 588     fn classify_name(&mut self, name: ast::Name) {
 589         if let Some(bind_pat) = name.syntax().parent().and_then(ast::IdentPat::cast) {
 590             self.is_pat_or_const = Some(PatternRefutability::Refutable);
 591             // if any of these is here our bind pat can't be a const pat anymore
 592             let complex_ident_pat = bind_pat.at_token().is_some()
 593                 || bind_pat.ref_token().is_some()
 594                 || bind_pat.mut_token().is_some();
 595             if complex_ident_pat {
 596                 self.is_pat_or_const = None;
 597             } else {
 598                 let irrefutable_pat = bind_pat.syntax().ancestors().find_map(|node| {
 599                     match_ast! {
 600                         match node {
 601                             ast::LetStmt(it) => Some(it.pat()),
 602                             ast::Param(it) => Some(it.pat()),
 603                             _ => None,
 604                         }
 605                     }
 606                 });
 607                 if let Some(Some(pat)) = irrefutable_pat {
 608                     // This check is here since we could be inside a pattern in the initializer expression of the let statement.
 609                     if pat.syntax().text_range().contains_range(bind_pat.syntax().text_range()) {
 610                         self.is_pat_or_const = Some(PatternRefutability::Irrefutable);
 611                     }
 612                 }
 613
 614                 let is_name_in_field_pat = bind_pat
 615                     .syntax()
 616                     .parent()
 617                     .and_then(ast::RecordPatField::cast)
 618                     .map_or(false, |pat_field| pat_field.name_ref().is_none());
 619                 if is_name_in_field_pat {
 620                     self.is_pat_or_const = None;
 621                 }
 622             }
 623
 624             self.fill_impl_def();
 625         }
 626
 627         self.is_param |= is_node::<ast::Param>(name.syntax());
 628     }
 629
 630     fn classify_name_ref(&mut self, original_file: &SyntaxNode, name_ref: ast::NameRef) {
 631         self.fill_impl_def();
 632
 633         self.name_ref_syntax =
 634             find_node_at_offset(original_file, name_ref.syntax().text_range().start());
 635
 636         self.function_def = self
 637             .sema
 638             .token_ancestors_with_macros(self.token.clone())
 639             .take_while(|it| it.kind() != SOURCE_FILE && it.kind() != MODULE)
 640             .find_map(ast::Fn::cast);
 641
 642         let parent = match name_ref.syntax().parent() {
 643             Some(it) => it,
 644             None => return,
 645         };
 646
 647         if let Some(segment) = ast::PathSegment::cast(parent) {
 648             let path_ctx = self.path_context.get_or_insert(PathCompletionContext {
 649                 call_kind: None,
 650                 is_trivial_path: false,
 651                 qualifier: None,
 652                 has_type_args: false,
 653                 can_be_stmt: false,
 654                 in_loop_body: false,
 655                 use_tree_parent: false,
 656                 kind: None,
 657             });
 658             path_ctx.in_loop_body = is_in_loop_body(name_ref.syntax());
 659             let path = segment.parent_path();
 660
 661             if let Some(p) = path.syntax().parent() {
 662                 path_ctx.call_kind = match_ast! {
 663                     match p {
 664                         ast::PathExpr(it) => it.syntax().parent().and_then(ast::CallExpr::cast).map(|_| CallKind::Expr),
 665                         ast::MacroCall(it) => it.excl_token().and(Some(CallKind::Mac)),
 666                         ast::TupleStructPat(_it) => Some(CallKind::Pat),
 667                         _ => None
 668                     }
 669                 };
 670             }
 671
 672             if let Some(parent) = path.syntax().parent() {
 673                 path_ctx.kind = match_ast! {
 674                     match parent {
 675                         ast::PathType(_it) => Some(PathKind::Type),
 676                         ast::PathExpr(_it) => Some(PathKind::Expr),
 677                         _ => None,
 678                     }
 679                 };
 680             }
 681             path_ctx.has_type_args = segment.generic_arg_list().is_some();
 682
 683             if let Some((path, use_tree_parent)) = path_or_use_tree_qualifier(&path) {
 684                 path_ctx.use_tree_parent = use_tree_parent;
 685                 path_ctx.qualifier = path
 686                     .segment()
 687                     .and_then(|it| {
 688                         find_node_with_range::<ast::PathSegment>(
 689                             original_file,
 690                             it.syntax().text_range(),
 691                         )
 692                     })
 693                     .map(|it| it.parent_path());
 694                 return;
 695             }
 696
 697             if let Some(segment) = path.segment() {
 698                 if segment.coloncolon_token().is_some() {
 699                     return;
 700                 }
 701             }
 702
 703             path_ctx.is_trivial_path = true;
 704
 705             // Find either enclosing expr statement (thing with `;`) or a
 706             // block. If block, check that we are the last expr.
 707             path_ctx.can_be_stmt = name_ref
 708                 .syntax()
 709                 .ancestors()
 710                 .find_map(|node| {
 711                     if let Some(stmt) = ast::ExprStmt::cast(node.clone()) {
 712                         return Some(stmt.syntax().text_range() == name_ref.syntax().text_range());
 713                     }
 714                     if let Some(block) = ast::BlockExpr::cast(node) {
 715                         return Some(
 716                             block.tail_expr().map(|e| e.syntax().text_range())
 717                                 == Some(name_ref.syntax().text_range()),
 718                         );
 719                     }
 720                     None
 721                 })
 722                 .unwrap_or(false);
 723         }
 724     }
 725 }
 726
 727 fn find_node_with_range<N: AstNode>(syntax: &SyntaxNode, range: TextRange) -> Option<N> {
 728     syntax.covering_element(range).ancestors().find_map(N::cast)
 729 }
 730
 731 fn is_node<N: AstNode>(node: &SyntaxNode) -> bool {
 732     match node.ancestors().find_map(N::cast) {
 733         None => false,
 734         Some(n) => n.syntax().text_range() == node.text_range(),
 735     }
 736 }
 737
 738 fn path_or_use_tree_qualifier(path: &ast::Path) -> Option<(ast::Path, bool)> {
 739     if let Some(qual) = path.qualifier() {
 740         return Some((qual, false));
 741     }
 742     let use_tree_list = path.syntax().ancestors().find_map(ast::UseTreeList::cast)?;
 743     let use_tree = use_tree_list.syntax().parent().and_then(ast::UseTree::cast)?;
 744     use_tree.path().zip(Some(true))
 745 }
 746
 747 fn has_ref(token: &SyntaxToken) -> bool {
 748     let mut token = token.clone();
 749     for skip in [WHITESPACE, IDENT, T![mut]] {
 750         if token.kind() == skip {
 751             token = match token.prev_token() {
 752                 Some(it) => it,
 753                 None => return false,
 754             }
 755         }
 756     }
 757     token.kind() == T![&]
 758 }
 759
 760 #[cfg(test)]
 761 mod tests {
 762     use expect_test::{expect, Expect};
 763     use hir::HirDisplay;
 764
 765     use crate::tests::{position, TEST_CONFIG};
 766
 767     use super::CompletionContext;
 768
 769     fn check_expected_type_and_name(ra_fixture: &str, expect: Expect) {
 770         let (db, pos) = position(ra_fixture);
 771         let completion_context = CompletionContext::new(&db, pos, &TEST_CONFIG).unwrap();
 772
 773         let ty = completion_context
 774             .expected_type
 775             .map(|t| t.display_test(&db).to_string())
 776             .unwrap_or("?".to_owned());
 777
 778         let name = completion_context
 779             .expected_name
 780             .map_or_else(|| "?".to_owned(), |name| name.to_string());
 781
 782         expect.assert_eq(&format!("ty: {}, name: {}", ty, name));
 783     }
 784
 785     #[test]
 786     fn expected_type_let_without_leading_char() {
 787         cov_mark::check!(expected_type_let_without_leading_char);
 788         check_expected_type_and_name(
 789             r#"
 790 fn foo() {
 791     let x: u32 = $0;
 792 }
 793 "#,
 794             expect![[r#"ty: u32, name: x"#]],
 795         );
 796     }
 797
 798     #[test]
 799     fn expected_type_let_with_leading_char() {
 800         cov_mark::check!(expected_type_let_with_leading_char);
 801         check_expected_type_and_name(
 802             r#"
 803 fn foo() {
 804     let x: u32 = c$0;
 805 }
 806 "#,
 807             expect![[r#"ty: u32, name: x"#]],
 808         );
 809     }
 810
 811     #[test]
 812     fn expected_type_let_pat() {
 813         check_expected_type_and_name(
 814             r#"
 815 fn foo() {
 816     let x$0 = 0u32;
 817 }
 818 "#,
 819             expect![[r#"ty: u32, name: ?"#]],
 820         );
 821         check_expected_type_and_name(
 822             r#"
 823 fn foo() {
 824     let $0 = 0u32;
 825 }
 826 "#,
 827             expect![[r#"ty: u32, name: ?"#]],
 828         );
 829     }
 830
 831     #[test]
 832     fn expected_type_fn_param() {
 833         cov_mark::check!(expected_type_fn_param);
 834         check_expected_type_and_name(
 835             r#"
 836 fn foo() { bar($0); }
 837 fn bar(x: u32) {}
 838 "#,
 839             expect![[r#"ty: u32, name: x"#]],
 840         );
 841         check_expected_type_and_name(
 842             r#"
 843 fn foo() { bar(c$0); }
 844 fn bar(x: u32) {}
 845 "#,
 846             expect![[r#"ty: u32, name: x"#]],
 847         );
 848     }
 849
 850     #[test]
 851     fn expected_type_fn_param_ref() {
 852         cov_mark::check!(expected_type_fn_param_ref);
 853         check_expected_type_and_name(
 854             r#"
 855 fn foo() { bar(&$0); }
 856 fn bar(x: &u32) {}
 857 "#,
 858             expect![[r#"ty: u32, name: x"#]],
 859         );
 860         check_expected_type_and_name(
 861             r#"
 862 fn foo() { bar(&mut $0); }
 863 fn bar(x: &mut u32) {}
 864 "#,
 865             expect![[r#"ty: u32, name: x"#]],
 866         );
 867         check_expected_type_and_name(
 868             r#"
 869 fn foo() { bar(&c$0); }
 870 fn bar(x: &u32) {}
 871         "#,
 872             expect![[r#"ty: u32, name: x"#]],
 873         );
 874     }
 875
 876     #[test]
 877     fn expected_type_struct_field_without_leading_char() {
 878         cov_mark::check!(expected_type_struct_field_without_leading_char);
 879         check_expected_type_and_name(
 880             r#"
 881 struct Foo { a: u32 }
 882 fn foo() {
 883     Foo { a: $0 };
 884 }
 885 "#,
 886             expect![[r#"ty: u32, name: a"#]],
 887         )
 888     }
 889
 890     #[test]
 891     fn expected_type_generic_struct_field() {
 892         check_expected_type_and_name(
 893             r#"
 894 struct Foo<T> { a: T }
 895 fn foo() -> Foo<u32> {
 896     Foo { a: $0 }
 897 }
 898 "#,
 899             expect![[r#"ty: u32, name: a"#]],
 900         )
 901     }
 902
 903     #[test]
 904     fn expected_type_struct_field_with_leading_char() {
 905         cov_mark::check!(expected_type_struct_field_with_leading_char);
 906         check_expected_type_and_name(
 907             r#"
 908 struct Foo { a: u32 }
 909 fn foo() {
 910     Foo { a: c$0 };
 911 }
 912 "#,
 913             expect![[r#"ty: u32, name: a"#]],
 914         );
 915     }
 916
 917     #[test]
 918     fn expected_type_match_arm_without_leading_char() {
 919         cov_mark::check!(expected_type_match_arm_without_leading_char);
 920         check_expected_type_and_name(
 921             r#"
 922 enum E { X }
 923 fn foo() {
 924    match E::X { $0 }
 925 }
 926 "#,
 927             expect![[r#"ty: E, name: ?"#]],
 928         );
 929     }
 930
 931     #[test]
 932     fn expected_type_match_arm_with_leading_char() {
 933         cov_mark::check!(expected_type_match_arm_with_leading_char);
 934         check_expected_type_and_name(
 935             r#"
 936 enum E { X }
 937 fn foo() {
 938    match E::X { c$0 }
 939 }
 940 "#,
 941             expect![[r#"ty: E, name: ?"#]],
 942         );
 943     }
 944
 945     #[test]
 946     fn expected_type_if_let_without_leading_char() {
 947         cov_mark::check!(expected_type_if_let_without_leading_char);
 948         check_expected_type_and_name(
 949             r#"
 950 enum Foo { Bar, Baz, Quux }
 951
 952 fn foo() {
 953     let f = Foo::Quux;
 954     if let $0 = f { }
 955 }
 956 "#,
 957             expect![[r#"ty: Foo, name: ?"#]],
 958         )
 959     }
 960
 961     #[test]
 962     fn expected_type_if_let_with_leading_char() {
 963         cov_mark::check!(expected_type_if_let_with_leading_char);
 964         check_expected_type_and_name(
 965             r#"
 966 enum Foo { Bar, Baz, Quux }
 967
 968 fn foo() {
 969     let f = Foo::Quux;
 970     if let c$0 = f { }
 971 }
 972 "#,
 973             expect![[r#"ty: Foo, name: ?"#]],
 974         )
 975     }
 976
 977     #[test]
 978     fn expected_type_fn_ret_without_leading_char() {
 979         cov_mark::check!(expected_type_fn_ret_without_leading_char);
 980         check_expected_type_and_name(
 981             r#"
 982 fn foo() -> u32 {
 983     $0
 984 }
 985 "#,
 986             expect![[r#"ty: u32, name: ?"#]],
 987         )
 988     }
 989
 990     #[test]
 991     fn expected_type_fn_ret_with_leading_char() {
 992         cov_mark::check!(expected_type_fn_ret_with_leading_char);
 993         check_expected_type_and_name(
 994             r#"
 995 fn foo() -> u32 {
 996     c$0
 997 }
 998 "#,
 999             expect![[r#"ty: u32, name: ?"#]],
1000         )
1001     }
1002
1003     #[test]
1004     fn expected_type_fn_ret_fn_ref_fully_typed() {
1005         check_expected_type_and_name(
1006             r#"
1007 fn foo() -> u32 {
1008     foo$0
1009 }
1010 "#,
1011             expect![[r#"ty: u32, name: ?"#]],
1012         )
1013     }
1014
1015     #[test]
1016     fn expected_type_closure_param_return() {
1017         // FIXME: make this work with `|| $0`
1018         check_expected_type_and_name(
1019             r#"
1020 //- minicore: fn
1021 fn foo() {
1022     bar(|| a$0);
1023 }
1024
1025 fn bar(f: impl FnOnce() -> u32) {}
1026 "#,
1027             expect![[r#"ty: u32, name: ?"#]],
1028         );
1029     }
1030
1031     #[test]
1032     fn expected_type_generic_function() {
1033         check_expected_type_and_name(
1034             r#"
1035 fn foo() {
1036     bar::<u32>($0);
1037 }
1038
1039 fn bar<T>(t: T) {}
1040 "#,
1041             expect![[r#"ty: u32, name: t"#]],
1042         );
1043     }
1044
1045     #[test]
1046     fn expected_type_generic_method() {
1047         check_expected_type_and_name(
1048             r#"
1049 fn foo() {
1050     S(1u32).bar($0);
1051 }
1052
1053 struct S<T>(T);
1054 impl<T> S<T> {
1055     fn bar(self, t: T) {}
1056 }
1057 "#,
1058             expect![[r#"ty: u32, name: t"#]],
1059         );
1060     }
1061 }