aboutsummaryrefslogtreecommitdiff
path: root/crates/ide_completion/src/context.rs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/ide_completion/src/context.rs')
-rw-r--r--crates/ide_completion/src/context.rs215
1 files changed, 116 insertions, 99 deletions
diff --git a/crates/ide_completion/src/context.rs b/crates/ide_completion/src/context.rs
index 2f3fb1710..9d761aa43 100644
--- a/crates/ide_completion/src/context.rs
+++ b/crates/ide_completion/src/context.rs
@@ -1,29 +1,37 @@
1//! See `CompletionContext` structure. 1//! See `CompletionContext` structure.
2 2
3use hir::{Local, ScopeDef, Semantics, SemanticsScope, Type}; 3use hir::{Local, ScopeDef, Semantics, SemanticsScope, Type};
4use ide_db::base_db::{FilePosition, SourceDatabase}; 4use ide_db::{
5use ide_db::{call_info::ActiveParameter, RootDatabase}; 5 base_db::{FilePosition, SourceDatabase},
6 call_info::ActiveParameter,
7 RootDatabase,
8};
6use syntax::{ 9use syntax::{
7 algo::find_node_at_offset, 10 algo::find_node_at_offset,
8 ast::{self, NameOrNameRef, NameOwner}, 11 ast::{self, NameOrNameRef, NameOwner},
9 match_ast, AstNode, NodeOrToken, 12 match_ast, AstNode, NodeOrToken,
10 SyntaxKind::*, 13 SyntaxKind::{self, *},
11 SyntaxNode, SyntaxToken, TextRange, TextSize, 14 SyntaxNode, SyntaxToken, TextRange, TextSize, T,
12}; 15};
13
14use text_edit::Indel; 16use text_edit::Indel;
15 17
16use crate::{ 18use crate::{
17 patterns::{ 19 patterns::{
18 fn_is_prev, for_is_prev2, has_bind_pat_parent, has_block_expr_parent, 20 for_is_prev2, has_bind_pat_parent, has_block_expr_parent, has_field_list_parent,
19 has_field_list_parent, has_impl_as_prev_sibling, has_impl_parent, 21 has_impl_as_prev_sibling, has_impl_parent, has_item_list_or_source_file_parent,
20 has_item_list_or_source_file_parent, has_ref_parent, has_trait_as_prev_sibling, 22 has_ref_parent, has_trait_as_prev_sibling, has_trait_parent, inside_impl_trait_block,
21 has_trait_parent, if_is_prev, inside_impl_trait_block, is_in_loop_body, is_match_arm, 23 is_in_loop_body, is_match_arm, previous_token,
22 unsafe_is_prev,
23 }, 24 },
24 CompletionConfig, 25 CompletionConfig,
25}; 26};
26 27
28#[derive(Debug, PartialEq, Eq)]
29pub(crate) enum IsPatOrConst {
30 No,
31 Refutable,
32 Irrefutable,
33}
34
27/// `CompletionContext` is created early during completion to figure out, where 35/// `CompletionContext` is created early during completion to figure out, where
28/// exactly is the cursor, syntax-wise. 36/// exactly is the cursor, syntax-wise.
29#[derive(Debug)] 37#[derive(Debug)]
@@ -41,23 +49,26 @@ pub(crate) struct CompletionContext<'a> {
41 pub(super) expected_name: Option<NameOrNameRef>, 49 pub(super) expected_name: Option<NameOrNameRef>,
42 pub(super) expected_type: Option<Type>, 50 pub(super) expected_type: Option<Type>,
43 pub(super) name_ref_syntax: Option<ast::NameRef>, 51 pub(super) name_ref_syntax: Option<ast::NameRef>,
44 pub(super) lifetime_syntax: Option<ast::Lifetime>,
45 pub(super) lifetime_param_syntax: Option<ast::LifetimeParam>,
46 pub(super) function_syntax: Option<ast::Fn>, 52 pub(super) function_syntax: Option<ast::Fn>,
47 pub(super) use_item_syntax: Option<ast::Use>, 53 pub(super) use_item_syntax: Option<ast::Use>,
48 pub(super) record_lit_syntax: Option<ast::RecordExpr>, 54 pub(super) record_lit_syntax: Option<ast::RecordExpr>,
49 pub(super) record_pat_syntax: Option<ast::RecordPat>, 55 pub(super) record_pat_syntax: Option<ast::RecordPat>,
50 pub(super) record_field_syntax: Option<ast::RecordExprField>, 56 pub(super) record_field_syntax: Option<ast::RecordExprField>,
57 /// The parent impl of the cursor position if it exists.
51 pub(super) impl_def: Option<ast::Impl>, 58 pub(super) impl_def: Option<ast::Impl>,
59
60 // potentially set if we are completing a lifetime
61 pub(super) lifetime_syntax: Option<ast::Lifetime>,
62 pub(super) lifetime_param_syntax: Option<ast::LifetimeParam>,
52 pub(super) lifetime_allowed: bool, 63 pub(super) lifetime_allowed: bool,
64 pub(super) is_label_ref: bool,
65
66 // potentially set if we are completing a name
67 pub(super) is_pat_or_const: IsPatOrConst,
68 pub(super) is_param: bool,
69
53 /// FIXME: `ActiveParameter` is string-based, which is very very wrong 70 /// FIXME: `ActiveParameter` is string-based, which is very very wrong
54 pub(super) active_parameter: Option<ActiveParameter>, 71 pub(super) active_parameter: Option<ActiveParameter>,
55 pub(super) is_param: bool,
56 pub(super) is_label_ref: bool,
57 /// If a name-binding or reference to a const in a pattern.
58 /// Irrefutable patterns (like let) are excluded.
59 pub(super) is_pat_binding_or_const: bool,
60 pub(super) is_irrefutable_pat_binding: bool,
61 /// A single-indent path, like `foo`. `::foo` should not be considered a trivial path. 72 /// A single-indent path, like `foo`. `::foo` should not be considered a trivial path.
62 pub(super) is_trivial_path: bool, 73 pub(super) is_trivial_path: bool,
63 /// If not a trivial path, the prefix (qualifier). 74 /// If not a trivial path, the prefix (qualifier).
@@ -81,27 +92,27 @@ pub(crate) struct CompletionContext<'a> {
81 pub(super) is_path_type: bool, 92 pub(super) is_path_type: bool,
82 pub(super) has_type_args: bool, 93 pub(super) has_type_args: bool,
83 pub(super) attribute_under_caret: Option<ast::Attr>, 94 pub(super) attribute_under_caret: Option<ast::Attr>,
95 pub(super) locals: Vec<(String, Local)>,
96
84 pub(super) mod_declaration_under_caret: Option<ast::Module>, 97 pub(super) mod_declaration_under_caret: Option<ast::Module>,
85 pub(super) unsafe_is_prev: bool, 98 pub(super) has_trait_parent: bool,
86 pub(super) if_is_prev: bool, 99 pub(super) has_impl_parent: bool,
100
101 // keyword patterns
102 pub(super) previous_token: Option<SyntaxToken>,
87 pub(super) block_expr_parent: bool, 103 pub(super) block_expr_parent: bool,
88 pub(super) bind_pat_parent: bool, 104 pub(super) bind_pat_parent: bool,
89 pub(super) ref_pat_parent: bool, 105 pub(super) ref_pat_parent: bool,
90 pub(super) in_loop_body: bool, 106 pub(super) in_loop_body: bool,
91 pub(super) has_trait_parent: bool,
92 pub(super) has_impl_parent: bool,
93 pub(super) inside_impl_trait_block: bool,
94 pub(super) has_field_list_parent: bool, 107 pub(super) has_field_list_parent: bool,
95 pub(super) trait_as_prev_sibling: bool, 108 pub(super) trait_as_prev_sibling: bool,
96 pub(super) impl_as_prev_sibling: bool, 109 pub(super) impl_as_prev_sibling: bool,
97 pub(super) is_match_arm: bool, 110 pub(super) is_match_arm: bool,
98 pub(super) has_item_list_or_source_file_parent: bool, 111 pub(super) has_item_list_or_source_file_parent: bool,
99 pub(super) for_is_prev2: bool,
100 pub(super) fn_is_prev: bool,
101 pub(super) incomplete_let: bool, 112 pub(super) incomplete_let: bool,
102 pub(super) locals: Vec<(String, Local)>,
103}
104 113
114 no_completion_required: bool,
115}
105impl<'a> CompletionContext<'a> { 116impl<'a> CompletionContext<'a> {
106 pub(super) fn new( 117 pub(super) fn new(
107 db: &'a RootDatabase, 118 db: &'a RootDatabase,
@@ -158,8 +169,7 @@ impl<'a> CompletionContext<'a> {
158 active_parameter: ActiveParameter::at(db, position), 169 active_parameter: ActiveParameter::at(db, position),
159 is_label_ref: false, 170 is_label_ref: false,
160 is_param: false, 171 is_param: false,
161 is_pat_binding_or_const: false, 172 is_pat_or_const: IsPatOrConst::No,
162 is_irrefutable_pat_binding: false,
163 is_trivial_path: false, 173 is_trivial_path: false,
164 path_qual: None, 174 path_qual: None,
165 after_if: false, 175 after_if: false,
@@ -175,22 +185,19 @@ impl<'a> CompletionContext<'a> {
175 has_type_args: false, 185 has_type_args: false,
176 attribute_under_caret: None, 186 attribute_under_caret: None,
177 mod_declaration_under_caret: None, 187 mod_declaration_under_caret: None,
178 unsafe_is_prev: false, 188 previous_token: None,
179 if_is_prev: false,
180 block_expr_parent: false, 189 block_expr_parent: false,
181 bind_pat_parent: false, 190 bind_pat_parent: false,
182 ref_pat_parent: false, 191 ref_pat_parent: false,
183 in_loop_body: false, 192 in_loop_body: false,
184 has_trait_parent: false, 193 has_trait_parent: false,
185 has_impl_parent: false, 194 has_impl_parent: false,
186 inside_impl_trait_block: false,
187 has_field_list_parent: false, 195 has_field_list_parent: false,
188 trait_as_prev_sibling: false, 196 trait_as_prev_sibling: false,
189 impl_as_prev_sibling: false, 197 impl_as_prev_sibling: false,
190 is_match_arm: false, 198 is_match_arm: false,
191 has_item_list_or_source_file_parent: false, 199 has_item_list_or_source_file_parent: false,
192 for_is_prev2: false, 200 no_completion_required: false,
193 fn_is_prev: false,
194 incomplete_let: false, 201 incomplete_let: false,
195 locals, 202 locals,
196 }; 203 };
@@ -245,7 +252,7 @@ impl<'a> CompletionContext<'a> {
245 /// Exception for this case is `impl Trait for Foo`, where we would like to hint trait method names. 252 /// Exception for this case is `impl Trait for Foo`, where we would like to hint trait method names.
246 /// - `for _ i$0` -- obviously, it'll be "in" keyword. 253 /// - `for _ i$0` -- obviously, it'll be "in" keyword.
247 pub(crate) fn no_completion_required(&self) -> bool { 254 pub(crate) fn no_completion_required(&self) -> bool {
248 (self.fn_is_prev && !self.inside_impl_trait_block) || self.for_is_prev2 255 self.no_completion_required
249 } 256 }
250 257
251 /// The range of the identifier that is being completed. 258 /// The range of the identifier that is being completed.
@@ -264,33 +271,39 @@ impl<'a> CompletionContext<'a> {
264 } 271 }
265 } 272 }
266 273
274 pub(crate) fn previous_token_is(&self, kind: SyntaxKind) -> bool {
275 self.previous_token.as_ref().map_or(false, |tok| tok.kind() == kind)
276 }
277
267 fn fill_keyword_patterns(&mut self, file_with_fake_ident: &SyntaxNode, offset: TextSize) { 278 fn fill_keyword_patterns(&mut self, file_with_fake_ident: &SyntaxNode, offset: TextSize) {
268 let fake_ident_token = file_with_fake_ident.token_at_offset(offset).right_biased().unwrap(); 279 let fake_ident_token = file_with_fake_ident.token_at_offset(offset).right_biased().unwrap();
269 let syntax_element = NodeOrToken::Token(fake_ident_token); 280 let syntax_element = NodeOrToken::Token(fake_ident_token);
281 self.previous_token = previous_token(syntax_element.clone());
270 self.block_expr_parent = has_block_expr_parent(syntax_element.clone()); 282 self.block_expr_parent = has_block_expr_parent(syntax_element.clone());
271 self.unsafe_is_prev = unsafe_is_prev(syntax_element.clone());
272 self.if_is_prev = if_is_prev(syntax_element.clone());
273 self.bind_pat_parent = has_bind_pat_parent(syntax_element.clone()); 283 self.bind_pat_parent = has_bind_pat_parent(syntax_element.clone());
274 self.ref_pat_parent = has_ref_parent(syntax_element.clone()); 284 self.ref_pat_parent = has_ref_parent(syntax_element.clone());
275 self.in_loop_body = is_in_loop_body(syntax_element.clone()); 285 self.in_loop_body = is_in_loop_body(syntax_element.clone());
276 self.has_trait_parent = has_trait_parent(syntax_element.clone()); 286 self.has_trait_parent = has_trait_parent(syntax_element.clone());
277 self.has_impl_parent = has_impl_parent(syntax_element.clone()); 287 self.has_impl_parent = has_impl_parent(syntax_element.clone());
278 self.inside_impl_trait_block = inside_impl_trait_block(syntax_element.clone());
279 self.has_field_list_parent = has_field_list_parent(syntax_element.clone()); 288 self.has_field_list_parent = has_field_list_parent(syntax_element.clone());
280 self.impl_as_prev_sibling = has_impl_as_prev_sibling(syntax_element.clone()); 289 self.impl_as_prev_sibling = has_impl_as_prev_sibling(syntax_element.clone());
281 self.trait_as_prev_sibling = has_trait_as_prev_sibling(syntax_element.clone()); 290 self.trait_as_prev_sibling = has_trait_as_prev_sibling(syntax_element.clone());
282 self.is_match_arm = is_match_arm(syntax_element.clone()); 291 self.is_match_arm = is_match_arm(syntax_element.clone());
292
283 self.has_item_list_or_source_file_parent = 293 self.has_item_list_or_source_file_parent =
284 has_item_list_or_source_file_parent(syntax_element.clone()); 294 has_item_list_or_source_file_parent(syntax_element.clone());
285 self.mod_declaration_under_caret = 295 self.mod_declaration_under_caret =
286 find_node_at_offset::<ast::Module>(&file_with_fake_ident, offset) 296 find_node_at_offset::<ast::Module>(&file_with_fake_ident, offset)
287 .filter(|module| module.item_list().is_none()); 297 .filter(|module| module.item_list().is_none());
288 self.for_is_prev2 = for_is_prev2(syntax_element.clone());
289 self.fn_is_prev = fn_is_prev(syntax_element.clone());
290 self.incomplete_let = 298 self.incomplete_let =
291 syntax_element.ancestors().take(6).find_map(ast::LetStmt::cast).map_or(false, |it| { 299 syntax_element.ancestors().take(6).find_map(ast::LetStmt::cast).map_or(false, |it| {
292 it.syntax().text_range().end() == syntax_element.text_range().end() 300 it.syntax().text_range().end() == syntax_element.text_range().end()
293 }); 301 });
302
303 let inside_impl_trait_block = inside_impl_trait_block(syntax_element.clone());
304 let fn_is_prev = self.previous_token_is(T![fn]);
305 let for_is_prev2 = for_is_prev2(syntax_element.clone());
306 self.no_completion_required = (fn_is_prev && !inside_impl_trait_block) || for_is_prev2;
294 } 307 }
295 308
296 fn fill_impl_def(&mut self) { 309 fn fill_impl_def(&mut self) {
@@ -412,67 +425,19 @@ impl<'a> CompletionContext<'a> {
412 self.expected_type = expected_type; 425 self.expected_type = expected_type;
413 self.expected_name = expected_name; 426 self.expected_name = expected_name;
414 self.attribute_under_caret = find_node_at_offset(&file_with_fake_ident, offset); 427 self.attribute_under_caret = find_node_at_offset(&file_with_fake_ident, offset);
415 428 let name_like = match find_node_at_offset(&&file_with_fake_ident, offset) {
416 if let Some(lifetime) = find_node_at_offset::<ast::Lifetime>(&file_with_fake_ident, offset) 429 Some(it) => it,
417 { 430 None => return,
418 self.classify_lifetime(original_file, lifetime, offset); 431 };
419 } 432 match name_like {
420 433 ast::NameLike::Lifetime(lifetime) => {
421 // First, let's try to complete a reference to some declaration. 434 self.classify_lifetime(original_file, lifetime, offset);
422 if let Some(name_ref) = find_node_at_offset::<ast::NameRef>(&file_with_fake_ident, offset) {
423 // Special case, `trait T { fn foo(i_am_a_name_ref) {} }`.
424 // See RFC#1685.
425 if is_node::<ast::Param>(name_ref.syntax()) {
426 self.is_param = true;
427 return;
428 }
429 // FIXME: remove this (V) duplication and make the check more precise
430 if name_ref.syntax().ancestors().find_map(ast::RecordPatFieldList::cast).is_some() {
431 self.record_pat_syntax =
432 self.sema.find_node_at_offset_with_macros(&original_file, offset);
433 }
434 self.classify_name_ref(original_file, name_ref, offset);
435 }
436
437 // Otherwise, see if this is a declaration. We can use heuristics to
438 // suggest declaration names, see `CompletionKind::Magic`.
439 if let Some(name) = find_node_at_offset::<ast::Name>(&file_with_fake_ident, offset) {
440 if let Some(bind_pat) = name.syntax().ancestors().find_map(ast::IdentPat::cast) {
441 self.is_pat_binding_or_const = true;
442 if bind_pat.at_token().is_some()
443 || bind_pat.ref_token().is_some()
444 || bind_pat.mut_token().is_some()
445 {
446 self.is_pat_binding_or_const = false;
447 }
448 if bind_pat.syntax().parent().and_then(ast::RecordPatFieldList::cast).is_some() {
449 self.is_pat_binding_or_const = false;
450 }
451 if let Some(Some(pat)) = bind_pat.syntax().ancestors().find_map(|node| {
452 match_ast! {
453 match node {
454 ast::LetStmt(it) => Some(it.pat()),
455 ast::Param(it) => Some(it.pat()),
456 _ => None,
457 }
458 }
459 }) {
460 if pat.syntax().text_range().contains_range(bind_pat.syntax().text_range()) {
461 self.is_pat_binding_or_const = false;
462 self.is_irrefutable_pat_binding = true;
463 }
464 }
465
466 self.fill_impl_def();
467 } 435 }
468 if is_node::<ast::Param>(name.syntax()) { 436 ast::NameLike::NameRef(name_ref) => {
469 self.is_param = true; 437 self.classify_name_ref(original_file, name_ref, offset);
470 return;
471 } 438 }
472 // FIXME: remove this (^) duplication and make the check more precise 439 ast::NameLike::Name(name) => {
473 if name.syntax().ancestors().find_map(ast::RecordPatFieldList::cast).is_some() { 440 self.classify_name(original_file, name, offset);
474 self.record_pat_syntax =
475 self.sema.find_node_at_offset_with_macros(&original_file, offset);
476 } 441 }
477 } 442 }
478 } 443 }
@@ -506,12 +471,64 @@ impl<'a> CompletionContext<'a> {
506 } 471 }
507 } 472 }
508 473
474 fn classify_name(&mut self, original_file: &SyntaxNode, name: ast::Name, offset: TextSize) {
475 if let Some(bind_pat) = name.syntax().parent().and_then(ast::IdentPat::cast) {
476 self.is_pat_or_const = IsPatOrConst::Refutable;
477 // if any of these is here our bind pat can't be a const pat anymore
478 let complex_ident_pat = bind_pat.at_token().is_some()
479 || bind_pat.ref_token().is_some()
480 || bind_pat.mut_token().is_some();
481 if complex_ident_pat {
482 self.is_pat_or_const = IsPatOrConst::No;
483 } else if let Some(pat_field) =
484 bind_pat.syntax().parent().and_then(ast::RecordPatField::cast)
485 {
486 if pat_field.name_ref().is_none() {
487 self.is_pat_or_const = IsPatOrConst::No;
488 }
489 } else {
490 let irrefutable_pat = bind_pat.syntax().ancestors().find_map(|node| {
491 match_ast! {
492 match node {
493 ast::LetStmt(it) => Some(it.pat()),
494 ast::Param(it) => Some(it.pat()),
495 _ => None,
496 }
497 }
498 });
499 if let Some(Some(pat)) = irrefutable_pat {
500 // This check is here since we could be inside a pattern in the initializer expression of the let statement.
501 if pat.syntax().text_range().contains_range(bind_pat.syntax().text_range()) {
502 self.is_pat_or_const = IsPatOrConst::Irrefutable;
503 }
504 }
505 }
506
507 self.fill_impl_def();
508 }
509 if is_node::<ast::Param>(name.syntax()) {
510 self.is_param = true;
511 return;
512 }
513 // FIXME: remove this (V) duplication and make the check more precise
514 if name.syntax().ancestors().find_map(ast::RecordPatFieldList::cast).is_some() {
515 self.record_pat_syntax =
516 self.sema.find_node_at_offset_with_macros(&original_file, offset);
517 }
518 }
519
509 fn classify_name_ref( 520 fn classify_name_ref(
510 &mut self, 521 &mut self,
511 original_file: &SyntaxNode, 522 original_file: &SyntaxNode,
512 name_ref: ast::NameRef, 523 name_ref: ast::NameRef,
513 offset: TextSize, 524 offset: TextSize,
514 ) { 525 ) {
526 // FIXME: remove this (^) duplication and make the check more precise
527 if name_ref.syntax().ancestors().find_map(ast::RecordPatFieldList::cast).is_some() {
528 self.record_pat_syntax =
529 self.sema.find_node_at_offset_with_macros(&original_file, offset);
530 }
531
515 self.name_ref_syntax = 532 self.name_ref_syntax =
516 find_node_at_offset(original_file, name_ref.syntax().text_range().start()); 533 find_node_at_offset(original_file, name_ref.syntax().text_range().start());
517 let name_range = name_ref.syntax().text_range(); 534 let name_range = name_ref.syntax().text_range();