diff options
author | Josh Mcguigan <[email protected]> | 2021-03-23 04:18:34 +0000 |
---|---|---|
committer | Josh Mcguigan <[email protected]> | 2021-03-26 16:18:18 +0000 |
commit | 0e31ae2cef92f973a6ee3def3f1feaa94dcb7a4f (patch) | |
tree | 50832b85e65752b040affcc8d34dc5cd8c2625b9 /crates | |
parent | 957939292ec9038f139bd10e093e9673609eea04 (diff) |
completion relevance distinguish between exact type match and could unify
Diffstat (limited to 'crates')
-rw-r--r-- | crates/ide_completion/src/item.rs | 59 | ||||
-rw-r--r-- | crates/ide_completion/src/render.rs | 56 | ||||
-rw-r--r-- | crates/ide_completion/src/render/enum_variant.rs | 4 | ||||
-rw-r--r-- | crates/ide_completion/src/render/function.rs | 4 | ||||
-rw-r--r-- | crates/rust-analyzer/src/to_proto.rs | 2 |
5 files changed, 81 insertions, 44 deletions
diff --git a/crates/ide_completion/src/item.rs b/crates/ide_completion/src/item.rs index 9a4b5217a..cc4ac9ea2 100644 --- a/crates/ide_completion/src/item.rs +++ b/crates/ide_completion/src/item.rs | |||
@@ -122,7 +122,7 @@ impl fmt::Debug for CompletionItem { | |||
122 | } | 122 | } |
123 | } | 123 | } |
124 | 124 | ||
125 | #[derive(Debug, Clone, Copy, Ord, PartialOrd, Eq, PartialEq, Default)] | 125 | #[derive(Debug, Clone, Copy, Eq, PartialEq, Default)] |
126 | pub struct CompletionRelevance { | 126 | pub struct CompletionRelevance { |
127 | /// This is set in cases like these: | 127 | /// This is set in cases like these: |
128 | /// | 128 | /// |
@@ -134,31 +134,41 @@ pub struct CompletionRelevance { | |||
134 | /// } | 134 | /// } |
135 | /// ``` | 135 | /// ``` |
136 | pub exact_name_match: bool, | 136 | pub exact_name_match: bool, |
137 | /// See CompletionRelevanceTypeMatch doc comments for cases where this is set. | ||
138 | pub type_match: Option<CompletionRelevanceTypeMatch>, | ||
137 | /// This is set in cases like these: | 139 | /// This is set in cases like these: |
138 | /// | 140 | /// |
139 | /// ``` | 141 | /// ``` |
140 | /// fn f(spam: String) {} | 142 | /// fn foo(a: u32) { |
141 | /// fn main { | 143 | /// let b = 0; |
142 | /// let foo = String::new(); | 144 | /// $0 // `a` and `b` are local |
143 | /// f($0) // type of local matches the type of param | ||
144 | /// } | 145 | /// } |
145 | /// ``` | 146 | /// ``` |
146 | pub exact_type_match: bool, | 147 | pub is_local: bool, |
148 | } | ||
149 | |||
150 | #[derive(Debug, Clone, Copy, Eq, PartialEq)] | ||
151 | pub enum CompletionRelevanceTypeMatch { | ||
147 | /// This is set in cases like these: | 152 | /// This is set in cases like these: |
148 | /// | 153 | /// |
149 | /// ``` | 154 | /// ``` |
150 | /// fn foo(bar: u32) { | 155 | /// enum Option<T> { Some(T), None } |
151 | /// $0 // `bar` is local | 156 | /// fn f(a: Option<u32>) {} |
157 | /// fn main { | ||
158 | /// f(Option::N$0) // type `Option<T>` could unify with `Option<u32>` | ||
152 | /// } | 159 | /// } |
153 | /// ``` | 160 | /// ``` |
161 | CouldUnify, | ||
162 | /// This is set in cases like these: | ||
154 | /// | 163 | /// |
155 | /// ``` | 164 | /// ``` |
156 | /// fn foo() { | 165 | /// fn f(spam: String) {} |
157 | /// let bar = 0; | 166 | /// fn main { |
158 | /// $0 // `bar` is local | 167 | /// let foo = String::new(); |
168 | /// f($0) // type of local matches the type of param | ||
159 | /// } | 169 | /// } |
160 | /// ``` | 170 | /// ``` |
161 | pub is_local: bool, | 171 | Exact, |
162 | } | 172 | } |
163 | 173 | ||
164 | impl CompletionRelevance { | 174 | impl CompletionRelevance { |
@@ -177,9 +187,11 @@ impl CompletionRelevance { | |||
177 | if self.exact_name_match { | 187 | if self.exact_name_match { |
178 | score += 1; | 188 | score += 1; |
179 | } | 189 | } |
180 | if self.exact_type_match { | 190 | score += match self.type_match { |
181 | score += 3; | 191 | Some(CompletionRelevanceTypeMatch::Exact) => 4, |
182 | } | 192 | Some(CompletionRelevanceTypeMatch::CouldUnify) => 3, |
193 | None => 0, | ||
194 | }; | ||
183 | if self.is_local { | 195 | if self.is_local { |
184 | score += 1; | 196 | score += 1; |
185 | } | 197 | } |
@@ -342,7 +354,7 @@ impl CompletionItem { | |||
342 | // match, but with exact type match set because self.ref_match | 354 | // match, but with exact type match set because self.ref_match |
343 | // is only set if there is an exact type match. | 355 | // is only set if there is an exact type match. |
344 | let mut relevance = self.relevance; | 356 | let mut relevance = self.relevance; |
345 | relevance.exact_type_match = true; | 357 | relevance.type_match = Some(CompletionRelevanceTypeMatch::Exact); |
346 | 358 | ||
347 | self.ref_match.map(|mutability| (mutability, relevance)) | 359 | self.ref_match.map(|mutability| (mutability, relevance)) |
348 | } | 360 | } |
@@ -523,7 +535,7 @@ mod tests { | |||
523 | use itertools::Itertools; | 535 | use itertools::Itertools; |
524 | use test_utils::assert_eq_text; | 536 | use test_utils::assert_eq_text; |
525 | 537 | ||
526 | use super::CompletionRelevance; | 538 | use super::{CompletionRelevance, CompletionRelevanceTypeMatch}; |
527 | 539 | ||
528 | /// Check that these are CompletionRelevance are sorted in ascending order | 540 | /// Check that these are CompletionRelevance are sorted in ascending order |
529 | /// by their relevance score. | 541 | /// by their relevance score. |
@@ -576,15 +588,22 @@ mod tests { | |||
576 | is_local: true, | 588 | is_local: true, |
577 | ..CompletionRelevance::default() | 589 | ..CompletionRelevance::default() |
578 | }], | 590 | }], |
579 | vec![CompletionRelevance { exact_type_match: true, ..CompletionRelevance::default() }], | 591 | vec![CompletionRelevance { |
592 | type_match: Some(CompletionRelevanceTypeMatch::CouldUnify), | ||
593 | ..CompletionRelevance::default() | ||
594 | }], | ||
595 | vec![CompletionRelevance { | ||
596 | type_match: Some(CompletionRelevanceTypeMatch::Exact), | ||
597 | ..CompletionRelevance::default() | ||
598 | }], | ||
580 | vec![CompletionRelevance { | 599 | vec![CompletionRelevance { |
581 | exact_name_match: true, | 600 | exact_name_match: true, |
582 | exact_type_match: true, | 601 | type_match: Some(CompletionRelevanceTypeMatch::Exact), |
583 | ..CompletionRelevance::default() | 602 | ..CompletionRelevance::default() |
584 | }], | 603 | }], |
585 | vec![CompletionRelevance { | 604 | vec![CompletionRelevance { |
586 | exact_name_match: true, | 605 | exact_name_match: true, |
587 | exact_type_match: true, | 606 | type_match: Some(CompletionRelevanceTypeMatch::Exact), |
588 | is_local: true, | 607 | is_local: true, |
589 | }], | 608 | }], |
590 | ]; | 609 | ]; |
diff --git a/crates/ide_completion/src/render.rs b/crates/ide_completion/src/render.rs index 12453f889..1a762d3dc 100644 --- a/crates/ide_completion/src/render.rs +++ b/crates/ide_completion/src/render.rs | |||
@@ -20,8 +20,8 @@ use ide_db::{ | |||
20 | use syntax::TextRange; | 20 | use syntax::TextRange; |
21 | 21 | ||
22 | use crate::{ | 22 | use crate::{ |
23 | item::ImportEdit, CompletionContext, CompletionItem, CompletionItemKind, CompletionKind, | 23 | item::{CompletionRelevanceTypeMatch, ImportEdit}, |
24 | CompletionRelevance, | 24 | CompletionContext, CompletionItem, CompletionItemKind, CompletionKind, CompletionRelevance, |
25 | }; | 25 | }; |
26 | 26 | ||
27 | use crate::render::{enum_variant::render_variant, function::render_fn, macro_::render_macro}; | 27 | use crate::render::{enum_variant::render_variant, function::render_fn, macro_::render_macro}; |
@@ -143,7 +143,7 @@ impl<'a> Render<'a> { | |||
143 | .set_deprecated(is_deprecated); | 143 | .set_deprecated(is_deprecated); |
144 | 144 | ||
145 | item.set_relevance(CompletionRelevance { | 145 | item.set_relevance(CompletionRelevance { |
146 | exact_type_match: compute_exact_type_match(self.ctx.completion, ty), | 146 | type_match: compute_type_match(self.ctx.completion, ty), |
147 | exact_name_match: compute_exact_name_match(self.ctx.completion, name.to_string()), | 147 | exact_name_match: compute_exact_name_match(self.ctx.completion, name.to_string()), |
148 | ..CompletionRelevance::default() | 148 | ..CompletionRelevance::default() |
149 | }); | 149 | }); |
@@ -245,7 +245,7 @@ impl<'a> Render<'a> { | |||
245 | } | 245 | } |
246 | 246 | ||
247 | item.set_relevance(CompletionRelevance { | 247 | item.set_relevance(CompletionRelevance { |
248 | exact_type_match: compute_exact_type_match(self.ctx.completion, &ty), | 248 | type_match: compute_type_match(self.ctx.completion, &ty), |
249 | exact_name_match: compute_exact_name_match(self.ctx.completion, &local_name), | 249 | exact_name_match: compute_exact_name_match(self.ctx.completion, &local_name), |
250 | is_local: true, | 250 | is_local: true, |
251 | ..CompletionRelevance::default() | 251 | ..CompletionRelevance::default() |
@@ -309,15 +309,24 @@ impl<'a> Render<'a> { | |||
309 | } | 309 | } |
310 | } | 310 | } |
311 | 311 | ||
312 | fn compute_exact_type_match(ctx: &CompletionContext, completion_ty: &hir::Type) -> bool { | 312 | fn compute_type_match( |
313 | match ctx.expected_type.as_ref() { | 313 | ctx: &CompletionContext, |
314 | Some(expected_type) => { | 314 | completion_ty: &hir::Type, |
315 | // We don't ever consider unit type to be an exact type match, since | 315 | ) -> Option<CompletionRelevanceTypeMatch> { |
316 | // nearly always this is not meaningful to the user. | 316 | let expected_type = ctx.expected_type.as_ref()?; |
317 | (completion_ty == expected_type || expected_type.could_unify_with(completion_ty)) | 317 | |
318 | && !expected_type.is_unit() | 318 | // We don't ever consider unit type to be an exact type match, since |
319 | } | 319 | // nearly always this is not meaningful to the user. |
320 | None => false, | 320 | if expected_type.is_unit() { |
321 | return None; | ||
322 | } | ||
323 | |||
324 | if completion_ty == expected_type { | ||
325 | Some(CompletionRelevanceTypeMatch::Exact) | ||
326 | } else if expected_type.could_unify_with(completion_ty) { | ||
327 | Some(CompletionRelevanceTypeMatch::CouldUnify) | ||
328 | } else { | ||
329 | None | ||
321 | } | 330 | } |
322 | } | 331 | } |
323 | 332 | ||
@@ -349,6 +358,7 @@ mod tests { | |||
349 | use itertools::Itertools; | 358 | use itertools::Itertools; |
350 | 359 | ||
351 | use crate::{ | 360 | use crate::{ |
361 | item::CompletionRelevanceTypeMatch, | ||
352 | test_utils::{check_edit, do_completion, get_all_items, TEST_CONFIG}, | 362 | test_utils::{check_edit, do_completion, get_all_items, TEST_CONFIG}, |
353 | CompletionKind, CompletionRelevance, | 363 | CompletionKind, CompletionRelevance, |
354 | }; | 364 | }; |
@@ -361,7 +371,11 @@ mod tests { | |||
361 | fn check_relevance(ra_fixture: &str, expect: Expect) { | 371 | fn check_relevance(ra_fixture: &str, expect: Expect) { |
362 | fn display_relevance(relevance: CompletionRelevance) -> String { | 372 | fn display_relevance(relevance: CompletionRelevance) -> String { |
363 | let relevance_factors = vec![ | 373 | let relevance_factors = vec![ |
364 | (relevance.exact_type_match, "type"), | 374 | (relevance.type_match == Some(CompletionRelevanceTypeMatch::Exact), "type"), |
375 | ( | ||
376 | relevance.type_match == Some(CompletionRelevanceTypeMatch::CouldUnify), | ||
377 | "type_could_unify", | ||
378 | ), | ||
365 | (relevance.exact_name_match, "name"), | 379 | (relevance.exact_name_match, "name"), |
366 | (relevance.is_local, "local"), | 380 | (relevance.is_local, "local"), |
367 | ] | 381 | ] |
@@ -534,7 +548,9 @@ fn main() { let _: m::Spam = S$0 } | |||
534 | detail: "(i32)", | 548 | detail: "(i32)", |
535 | relevance: CompletionRelevance { | 549 | relevance: CompletionRelevance { |
536 | exact_name_match: false, | 550 | exact_name_match: false, |
537 | exact_type_match: true, | 551 | type_match: Some( |
552 | Exact, | ||
553 | ), | ||
538 | is_local: false, | 554 | is_local: false, |
539 | }, | 555 | }, |
540 | trigger_call_info: true, | 556 | trigger_call_info: true, |
@@ -560,7 +576,9 @@ fn main() { let _: m::Spam = S$0 } | |||
560 | detail: "()", | 576 | detail: "()", |
561 | relevance: CompletionRelevance { | 577 | relevance: CompletionRelevance { |
562 | exact_name_match: false, | 578 | exact_name_match: false, |
563 | exact_type_match: true, | 579 | type_match: Some( |
580 | Exact, | ||
581 | ), | ||
564 | is_local: false, | 582 | is_local: false, |
565 | }, | 583 | }, |
566 | }, | 584 | }, |
@@ -1109,7 +1127,7 @@ fn main() { | |||
1109 | detail: "S", | 1127 | detail: "S", |
1110 | relevance: CompletionRelevance { | 1128 | relevance: CompletionRelevance { |
1111 | exact_name_match: true, | 1129 | exact_name_match: true, |
1112 | exact_type_match: false, | 1130 | type_match: None, |
1113 | is_local: true, | 1131 | is_local: true, |
1114 | }, | 1132 | }, |
1115 | ref_match: "&mut ", | 1133 | ref_match: "&mut ", |
@@ -1374,8 +1392,8 @@ fn foo() { | |||
1374 | } | 1392 | } |
1375 | "#, | 1393 | "#, |
1376 | expect![[r#" | 1394 | expect![[r#" |
1377 | ev Foo::A(…) [type] | 1395 | ev Foo::A(…) [type_could_unify] |
1378 | ev Foo::B [type] | 1396 | ev Foo::B [type_could_unify] |
1379 | lc foo [type+local] | 1397 | lc foo [type+local] |
1380 | en Foo [] | 1398 | en Foo [] |
1381 | fn baz() [] | 1399 | fn baz() [] |
diff --git a/crates/ide_completion/src/render/enum_variant.rs b/crates/ide_completion/src/render/enum_variant.rs index 374247b05..832f5ced1 100644 --- a/crates/ide_completion/src/render/enum_variant.rs +++ b/crates/ide_completion/src/render/enum_variant.rs | |||
@@ -6,7 +6,7 @@ use itertools::Itertools; | |||
6 | 6 | ||
7 | use crate::{ | 7 | use crate::{ |
8 | item::{CompletionItem, CompletionKind, ImportEdit}, | 8 | item::{CompletionItem, CompletionKind, ImportEdit}, |
9 | render::{builder_ext::Params, compute_exact_type_match, compute_ref_match, RenderContext}, | 9 | render::{builder_ext::Params, compute_ref_match, compute_type_match, RenderContext}, |
10 | CompletionRelevance, | 10 | CompletionRelevance, |
11 | }; | 11 | }; |
12 | 12 | ||
@@ -77,7 +77,7 @@ impl<'a> EnumRender<'a> { | |||
77 | 77 | ||
78 | let ty = self.variant.parent_enum(self.ctx.completion.db).ty(self.ctx.completion.db); | 78 | let ty = self.variant.parent_enum(self.ctx.completion.db).ty(self.ctx.completion.db); |
79 | item.set_relevance(CompletionRelevance { | 79 | item.set_relevance(CompletionRelevance { |
80 | exact_type_match: compute_exact_type_match(self.ctx.completion, &ty), | 80 | type_match: compute_type_match(self.ctx.completion, &ty), |
81 | ..CompletionRelevance::default() | 81 | ..CompletionRelevance::default() |
82 | }); | 82 | }); |
83 | 83 | ||
diff --git a/crates/ide_completion/src/render/function.rs b/crates/ide_completion/src/render/function.rs index b1eba20e8..d681e2c91 100644 --- a/crates/ide_completion/src/render/function.rs +++ b/crates/ide_completion/src/render/function.rs | |||
@@ -8,7 +8,7 @@ use syntax::ast::Fn; | |||
8 | use crate::{ | 8 | use crate::{ |
9 | item::{CompletionItem, CompletionItemKind, CompletionKind, CompletionRelevance, ImportEdit}, | 9 | item::{CompletionItem, CompletionItemKind, CompletionKind, CompletionRelevance, ImportEdit}, |
10 | render::{ | 10 | render::{ |
11 | builder_ext::Params, compute_exact_name_match, compute_exact_type_match, compute_ref_match, | 11 | builder_ext::Params, compute_exact_name_match, compute_ref_match, compute_type_match, |
12 | RenderContext, | 12 | RenderContext, |
13 | }, | 13 | }, |
14 | }; | 14 | }; |
@@ -73,7 +73,7 @@ impl<'a> FunctionRender<'a> { | |||
73 | 73 | ||
74 | let ret_type = self.func.ret_type(self.ctx.db()); | 74 | let ret_type = self.func.ret_type(self.ctx.db()); |
75 | item.set_relevance(CompletionRelevance { | 75 | item.set_relevance(CompletionRelevance { |
76 | exact_type_match: compute_exact_type_match(self.ctx.completion, &ret_type), | 76 | type_match: compute_type_match(self.ctx.completion, &ret_type), |
77 | exact_name_match: compute_exact_name_match(self.ctx.completion, self.name.clone()), | 77 | exact_name_match: compute_exact_name_match(self.ctx.completion, self.name.clone()), |
78 | ..CompletionRelevance::default() | 78 | ..CompletionRelevance::default() |
79 | }); | 79 | }); |
diff --git a/crates/rust-analyzer/src/to_proto.rs b/crates/rust-analyzer/src/to_proto.rs index 25169005f..530c8a5a4 100644 --- a/crates/rust-analyzer/src/to_proto.rs +++ b/crates/rust-analyzer/src/to_proto.rs | |||
@@ -1138,7 +1138,7 @@ mod tests { | |||
1138 | ( | 1138 | ( |
1139 | "&arg", | 1139 | "&arg", |
1140 | Some( | 1140 | Some( |
1141 | "fffffffa", | 1141 | "fffffff9", |
1142 | ), | 1142 | ), |
1143 | ), | 1143 | ), |
1144 | ( | 1144 | ( |