Skip to content

Commit e6ec860

Browse files
bors[bot]Veykril
bors[bot]
and
Veykril
authored
9039: feat: Complete fields and methods with `self.` prefixed when inside methods r=matklad a=Veykril ![w65NbjkZiG](https://user-images.githubusercontent.com/3757771/119984385-a0111700-bfc1-11eb-9dbf-52fdaa4d72b5.gif) Closes rust-lang#7173 Co-authored-by: Lukas Wirth <lukastw97@gmail.com>
2 parents e9a7977 + fb7105a commit e6ec860

File tree

14 files changed

+170
-26
lines changed

14 files changed

+170
-26
lines changed

‎crates/ide_completion/src/completions.rs

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,18 +69,25 @@ impl Completions {
6969
items.into_iter().for_each(|item| self.add(item.into()))
7070
}
7171

72-
pub(crate) fn add_field(&mut self, ctx: &CompletionContext, field: hir::Field, ty: &hir::Type) {
73-
let item = render_field(RenderContext::new(ctx), field, ty);
72+
pub(crate) fn add_field(
73+
&mut self,
74+
ctx: &CompletionContext,
75+
receiver: Option<hir::Name>,
76+
field: hir::Field,
77+
ty: &hir::Type,
78+
) {
79+
let item = render_field(RenderContext::new(ctx), receiver, field, ty);
7480
self.add(item);
7581
}
7682

7783
pub(crate) fn add_tuple_field(
7884
&mut self,
7985
ctx: &CompletionContext,
86+
receiver: Option<hir::Name>,
8087
field: usize,
8188
ty: &hir::Type,
8289
) {
83-
let item = render_tuple_field(RenderContext::new(ctx), field, ty);
90+
let item = render_tuple_field(RenderContext::new(ctx), receiver, field, ty);
8491
self.add(item);
8592
}
8693

@@ -132,9 +139,11 @@ impl Completions {
132139
&mut self,
133140
ctx: &CompletionContext,
134141
func: hir::Function,
142+
receiver: Option<hir::Name>,
135143
local_name: Option<hir::Name>,
136144
) {
137-
if let Some(item) = render_method(RenderContext::new(ctx), None, local_name, func) {
145+
if let Some(item) = render_method(RenderContext::new(ctx), None, receiver, local_name, func)
146+
{
138147
self.add(item)
139148
}
140149
}

‎crates/ide_completion/src/completions/dot.rs

Lines changed: 75 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
//! Completes references after dot (fields and method calls).
22
3-
use hir::{HasVisibility, Type};
3+
use either::Either;
4+
use hir::{HasVisibility, ScopeDef};
45
use rustc_hash::FxHashSet;
56

67
use crate::{context::CompletionContext, Completions};
@@ -9,7 +10,7 @@ use crate::{context::CompletionContext, Completions};
910
pub(crate) fn complete_dot(acc: &mut Completions, ctx: &CompletionContext) {
1011
let dot_receiver = match &ctx.dot_receiver {
1112
Some(expr) => expr,
12-
_ => return,
13+
_ => return complete_undotted_self(acc, ctx),
1314
};
1415

1516
let receiver_ty = match ctx.sema.type_of_expr(&dot_receiver) {
@@ -20,29 +21,64 @@ pub(crate) fn complete_dot(acc: &mut Completions, ctx: &CompletionContext) {
2021
if ctx.is_call {
2122
cov_mark::hit!(test_no_struct_field_completion_for_method_call);
2223
} else {
23-
complete_fields(acc, ctx, &receiver_ty);
24+
complete_fields(ctx, &receiver_ty, |field, ty| match field {
25+
Either::Left(field) => acc.add_field(ctx, None, field, &ty),
26+
Either::Right(tuple_idx) => acc.add_tuple_field(ctx, None, tuple_idx, &ty),
27+
});
2428
}
25-
complete_methods(acc, ctx, &receiver_ty);
29+
complete_methods(ctx, &receiver_ty, |func| acc.add_method(ctx, func, None, None));
30+
}
31+
32+
fn complete_undotted_self(acc: &mut Completions, ctx: &CompletionContext) {
33+
if !ctx.is_trivial_path || !ctx.config.enable_self_on_the_fly {
34+
return;
35+
}
36+
ctx.scope.process_all_names(&mut |name, def| {
37+
if let ScopeDef::Local(local) = &def {
38+
if local.is_self(ctx.db) {
39+
let ty = local.ty(ctx.db);
40+
complete_fields(ctx, &ty, |field, ty| match field {
41+
either::Either::Left(field) => {
42+
acc.add_field(ctx, Some(name.clone()), field, &ty)
43+
}
44+
either::Either::Right(tuple_idx) => {
45+
acc.add_tuple_field(ctx, Some(name.clone()), tuple_idx, &ty)
46+
}
47+
});
48+
complete_methods(ctx, &ty, |func| {
49+
acc.add_method(ctx, func, Some(name.clone()), None)
50+
});
51+
}
52+
}
53+
});
2654
}
2755

28-
fn complete_fields(acc: &mut Completions, ctx: &CompletionContext, receiver: &Type) {
56+
fn complete_fields(
57+
ctx: &CompletionContext,
58+
receiver: &hir::Type,
59+
mut f: impl FnMut(Either<hir::Field, usize>, hir::Type),
60+
) {
2961
for receiver in receiver.autoderef(ctx.db) {
3062
for (field, ty) in receiver.fields(ctx.db) {
3163
if ctx.scope.module().map_or(false, |m| !field.is_visible_from(ctx.db, m)) {
3264
// Skip private field. FIXME: If the definition location of the
3365
// field is editable, we should show the completion
3466
continue;
3567
}
36-
acc.add_field(ctx, field, &ty);
68+
f(Either::Left(field), ty);
3769
}
3870
for (i, ty) in receiver.tuple_fields(ctx.db).into_iter().enumerate() {
3971
// FIXME: Handle visibility
40-
acc.add_tuple_field(ctx, i, &ty);
72+
f(Either::Right(i), ty);
4173
}
4274
}
4375
}
4476

45-
fn complete_methods(acc: &mut Completions, ctx: &CompletionContext, receiver: &Type) {
77+
fn complete_methods(
78+
ctx: &CompletionContext,
79+
receiver: &hir::Type,
80+
mut f: impl FnMut(hir::Function),
81+
) {
4682
if let Some(krate) = ctx.krate {
4783
let mut seen_methods = FxHashSet::default();
4884
let traits_in_scope = ctx.scope.traits_in_scope();
@@ -51,7 +87,7 @@ fn complete_methods(acc: &mut Completions, ctx: &CompletionContext, receiver: &T
5187
&& ctx.scope.module().map_or(true, |m| func.is_visible_from(ctx.db, m))
5288
&& seen_methods.insert(func.name(ctx.db))
5389
{
54-
acc.add_method(ctx, func, None);
90+
f(func);
5591
}
5692
None::<()>
5793
});
@@ -484,4 +520,34 @@ impl S {
484520
"#]],
485521
);
486522
}
523+
524+
#[test]
525+
fn completes_bare_fields_and_methods_in_methods() {
526+
check(
527+
r#"
528+
struct Foo { field: i32 }
529+
530+
impl Foo { fn foo(&self) { $0 } }"#,
531+
expect![[r#"
532+
lc self &Foo
533+
sp Self
534+
st Foo
535+
fd self.field i32
536+
me self.foo() fn(&self)
537+
"#]],
538+
);
539+
check(
540+
r#"
541+
struct Foo(i32);
542+
543+
impl Foo { fn foo(&mut self) { $0 } }"#,
544+
expect![[r#"
545+
lc self &mut Foo
546+
sp Self
547+
st Foo
548+
fd self.0 i32
549+
me self.foo() fn(&mut self)
550+
"#]],
551+
);
552+
}
487553
}

‎crates/ide_completion/src/completions/record.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ pub(crate) fn complete_record(acc: &mut Completions, ctx: &CompletionContext) ->
3939
};
4040

4141
for (field, ty) in missing_fields {
42-
acc.add_field(ctx, field, &ty);
42+
acc.add_field(ctx, None, field, &ty);
4343
}
4444

4545
Some(())

‎crates/ide_completion/src/completions/unqualified_path.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ pub(crate) fn complete_unqualified_path(acc: &mut Completions, ctx: &CompletionC
1111
if ctx.is_path_disallowed() || ctx.expects_item() {
1212
return;
1313
}
14+
1415
if ctx.expects_assoc_item() {
1516
ctx.scope.process_all_names(&mut |name, def| {
1617
if let ScopeDef::MacroDef(macro_def) = def {
@@ -32,6 +33,7 @@ pub(crate) fn complete_unqualified_path(acc: &mut Completions, ctx: &CompletionC
3233
});
3334
return;
3435
}
36+
3537
if let Some(hir::Adt::Enum(e)) =
3638
ctx.expected_type.as_ref().and_then(|ty| ty.strip_references().as_adt())
3739
{

‎crates/ide_completion/src/config.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ use ide_db::helpers::{insert_use::InsertUseConfig, SnippetCap};
1010
pub struct CompletionConfig {
1111
pub enable_postfix_completions: bool,
1212
pub enable_imports_on_the_fly: bool,
13+
pub enable_self_on_the_fly: bool,
1314
pub add_call_parenthesis: bool,
1415
pub add_call_argument_snippets: bool,
1516
pub snippet_cap: Option<SnippetCap>,

‎crates/ide_completion/src/render.rs

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,20 @@ use crate::{
2525

2626
pub(crate) fn render_field<'a>(
2727
ctx: RenderContext<'a>,
28+
receiver: Option<hir::Name>,
2829
field: hir::Field,
2930
ty: &hir::Type,
3031
) -> CompletionItem {
31-
Render::new(ctx).render_field(field, ty)
32+
Render::new(ctx).render_field(receiver, field, ty)
3233
}
3334

3435
pub(crate) fn render_tuple_field<'a>(
3536
ctx: RenderContext<'a>,
37+
receiver: Option<hir::Name>,
3638
field: usize,
3739
ty: &hir::Type,
3840
) -> CompletionItem {
39-
Render::new(ctx).render_tuple_field(field, ty)
41+
Render::new(ctx).render_tuple_field(receiver, field, ty)
4042
}
4143

4244
pub(crate) fn render_resolution<'a>(
@@ -126,11 +128,19 @@ impl<'a> Render<'a> {
126128
Render { ctx }
127129
}
128130

129-
fn render_field(&self, field: hir::Field, ty: &hir::Type) -> CompletionItem {
131+
fn render_field(
132+
&self,
133+
receiver: Option<hir::Name>,
134+
field: hir::Field,
135+
ty: &hir::Type,
136+
) -> CompletionItem {
130137
let is_deprecated = self.ctx.is_deprecated(field);
131138
let name = field.name(self.ctx.db()).to_string();
132-
let mut item =
133-
CompletionItem::new(CompletionKind::Reference, self.ctx.source_range(), name.clone());
139+
let mut item = CompletionItem::new(
140+
CompletionKind::Reference,
141+
self.ctx.source_range(),
142+
receiver.map_or_else(|| name.clone(), |receiver| format!("{}.{}", receiver, name)),
143+
);
134144
item.kind(SymbolKind::Field)
135145
.detail(ty.display(self.ctx.db()).to_string())
136146
.set_documentation(field.docs(self.ctx.db()))
@@ -151,11 +161,17 @@ impl<'a> Render<'a> {
151161
item.build()
152162
}
153163

154-
fn render_tuple_field(&self, field: usize, ty: &hir::Type) -> CompletionItem {
164+
fn render_tuple_field(
165+
&self,
166+
receiver: Option<hir::Name>,
167+
field: usize,
168+
ty: &hir::Type,
169+
) -> CompletionItem {
155170
let mut item = CompletionItem::new(
156171
CompletionKind::Reference,
157172
self.ctx.source_range(),
158-
field.to_string(),
173+
receiver
174+
.map_or_else(|| field.to_string(), |receiver| format!("{}.{}", receiver, field)),
159175
);
160176

161177
item.kind(SymbolKind::Field).detail(ty.display(self.ctx.db()).to_string());

‎crates/ide_completion/src/render/function.rs

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,25 @@ pub(crate) fn render_fn<'a>(
2020
fn_: hir::Function,
2121
) -> Option<CompletionItem> {
2222
let _p = profile::span("render_fn");
23-
Some(FunctionRender::new(ctx, local_name, fn_, false)?.render(import_to_add))
23+
Some(FunctionRender::new(ctx, None, local_name, fn_, false)?.render(import_to_add))
2424
}
2525

2626
pub(crate) fn render_method<'a>(
2727
ctx: RenderContext<'a>,
2828
import_to_add: Option<ImportEdit>,
29+
receiver: Option<hir::Name>,
2930
local_name: Option<hir::Name>,
3031
fn_: hir::Function,
3132
) -> Option<CompletionItem> {
3233
let _p = profile::span("render_method");
33-
Some(FunctionRender::new(ctx, local_name, fn_, true)?.render(import_to_add))
34+
Some(FunctionRender::new(ctx, receiver, local_name, fn_, true)?.render(import_to_add))
3435
}
3536

3637
#[derive(Debug)]
3738
struct FunctionRender<'a> {
3839
ctx: RenderContext<'a>,
3940
name: String,
41+
receiver: Option<hir::Name>,
4042
func: hir::Function,
4143
ast_node: Fn,
4244
is_method: bool,
@@ -45,18 +47,22 @@ struct FunctionRender<'a> {
4547
impl<'a> FunctionRender<'a> {
4648
fn new(
4749
ctx: RenderContext<'a>,
50+
receiver: Option<hir::Name>,
4851
local_name: Option<hir::Name>,
4952
fn_: hir::Function,
5053
is_method: bool,
5154
) -> Option<FunctionRender<'a>> {
5255
let name = local_name.unwrap_or_else(|| fn_.name(ctx.db())).to_string();
5356
let ast_node = fn_.source(ctx.db())?.value;
5457

55-
Some(FunctionRender { ctx, name, func: fn_, ast_node, is_method })
58+
Some(FunctionRender { ctx, name, receiver, func: fn_, ast_node, is_method })
5659
}
5760

58-
fn render(self, import_to_add: Option<ImportEdit>) -> CompletionItem {
61+
fn render(mut self, import_to_add: Option<ImportEdit>) -> CompletionItem {
5962
let params = self.params();
63+
if let Some(receiver) = &self.receiver {
64+
self.name = format!("{}.{}", receiver, &self.name)
65+
}
6066
let mut item = CompletionItem::new(
6167
CompletionKind::Reference,
6268
self.ctx.source_range(),
@@ -148,7 +154,7 @@ impl<'a> FunctionRender<'a> {
148154
};
149155

150156
let mut params_pats = Vec::new();
151-
let params_ty = if self.ctx.completion.dot_receiver.is_some() {
157+
let params_ty = if self.ctx.completion.dot_receiver.is_some() || self.receiver.is_some() {
152158
self.func.method_params(self.ctx.db()).unwrap_or_default()
153159
} else {
154160
if let Some(s) = ast_params.self_param() {
@@ -253,6 +259,26 @@ impl S {
253259
fn bar(s: &S) {
254260
s.foo(${1:x})$0
255261
}
262+
"#,
263+
);
264+
265+
check_edit(
266+
"self.foo",
267+
r#"
268+
struct S {}
269+
impl S {
270+
fn foo(&self, x: i32) {
271+
$0
272+
}
273+
}
274+
"#,
275+
r#"
276+
struct S {}
277+
impl S {
278+
fn foo(&self, x: i32) {
279+
self.foo(${1:x})$0
280+
}
281+
}
256282
"#,
257283
);
258284
}

‎crates/ide_completion/src/test_utils.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ use crate::{item::CompletionKind, CompletionConfig, CompletionItem};
1919
pub(crate) const TEST_CONFIG: CompletionConfig = CompletionConfig {
2020
enable_postfix_completions: true,
2121
enable_imports_on_the_fly: true,
22+
enable_self_on_the_fly: true,
2223
add_call_parenthesis: true,
2324
add_call_argument_snippets: true,
2425
snippet_cap: SnippetCap::new(true),

‎crates/rust-analyzer/src/config.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,9 @@ config_data! {
100100
/// Toggles the additional completions that automatically add imports when completed.
101101
/// Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
102102
completion_autoimport_enable: bool = "true",
103+
/// Toggles the additional completions that automatically show method calls and field accesses
104+
/// with `self` prefixed to them when inside a method.
105+
completion_autoself_enable: bool = "true",
103106

104107
/// Whether to show native rust-analyzer diagnostics.
105108
diagnostics_enable: bool = "true",
@@ -666,6 +669,7 @@ impl Config {
666669
enable_postfix_completions: self.data.completion_postfix_enable,
667670
enable_imports_on_the_fly: self.data.completion_autoimport_enable
668671
&& completion_item_edit_resolve(&self.caps),
672+
enable_self_on_the_fly: self.data.completion_autoself_enable,
669673
add_call_parenthesis: self.data.completion_addCallParenthesis,
670674
add_call_argument_snippets: self.data.completion_addCallArgumentSnippets,
671675
insert_use: self.insert_use_config(),

0 commit comments

Comments
 (0)