crates/ide_completion/src/context.rs

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