diff options
Diffstat (limited to 'crates/ra_assists/src/add_missing_impl_members.rs')
-rw-r--r-- | crates/ra_assists/src/add_missing_impl_members.rs | 283 |
1 files changed, 283 insertions, 0 deletions
diff --git a/crates/ra_assists/src/add_missing_impl_members.rs b/crates/ra_assists/src/add_missing_impl_members.rs new file mode 100644 index 000000000..4435c4b5d --- /dev/null +++ b/crates/ra_assists/src/add_missing_impl_members.rs | |||
@@ -0,0 +1,283 @@ | |||
1 | use crate::{Assist, AssistId, AssistCtx}; | ||
2 | |||
3 | use hir::Resolver; | ||
4 | use hir::db::HirDatabase; | ||
5 | use ra_syntax::{SmolStr, SyntaxKind, TextRange, TextUnit, TreeArc}; | ||
6 | use ra_syntax::ast::{self, AstNode, FnDef, ImplItem, ImplItemKind, NameOwner}; | ||
7 | use ra_db::FilePosition; | ||
8 | use ra_fmt::{leading_indent, reindent}; | ||
9 | |||
10 | use itertools::Itertools; | ||
11 | |||
12 | pub(crate) fn add_missing_impl_members(mut ctx: AssistCtx<impl HirDatabase>) -> Option<Assist> { | ||
13 | let impl_node = ctx.node_at_offset::<ast::ImplBlock>()?; | ||
14 | let impl_item_list = impl_node.item_list()?; | ||
15 | |||
16 | let trait_def = { | ||
17 | let file_id = ctx.frange.file_id; | ||
18 | let position = FilePosition { file_id, offset: impl_node.syntax().range().start() }; | ||
19 | let resolver = hir::source_binder::resolver_for_position(ctx.db, position); | ||
20 | |||
21 | resolve_target_trait_def(ctx.db, &resolver, impl_node)? | ||
22 | }; | ||
23 | |||
24 | let missing_fns: Vec<_> = { | ||
25 | let fn_def_opt = |kind| if let ImplItemKind::FnDef(def) = kind { Some(def) } else { None }; | ||
26 | let def_name = |def| -> Option<&SmolStr> { FnDef::name(def).map(ast::Name::text) }; | ||
27 | |||
28 | let trait_items = | ||
29 | trait_def.syntax().descendants().find_map(ast::ItemList::cast)?.impl_items(); | ||
30 | let impl_items = impl_item_list.impl_items(); | ||
31 | |||
32 | let trait_fns = trait_items.map(ImplItem::kind).filter_map(fn_def_opt).collect::<Vec<_>>(); | ||
33 | let impl_fns = impl_items.map(ImplItem::kind).filter_map(fn_def_opt).collect::<Vec<_>>(); | ||
34 | |||
35 | trait_fns | ||
36 | .into_iter() | ||
37 | .filter(|t| def_name(t).is_some()) | ||
38 | .filter(|t| impl_fns.iter().all(|i| def_name(i) != def_name(t))) | ||
39 | .collect() | ||
40 | }; | ||
41 | if missing_fns.is_empty() { | ||
42 | return None; | ||
43 | } | ||
44 | |||
45 | ctx.add_action(AssistId("add_impl_missing_members"), "add missing impl members", |edit| { | ||
46 | let (parent_indent, indent) = { | ||
47 | // FIXME: Find a way to get the indent already used in the file. | ||
48 | // Now, we copy the indent of first item or indent with 4 spaces relative to impl block | ||
49 | const DEFAULT_INDENT: &str = " "; | ||
50 | let first_item = impl_item_list.impl_items().next(); | ||
51 | let first_item_indent = | ||
52 | first_item.and_then(|i| leading_indent(i.syntax())).map(ToOwned::to_owned); | ||
53 | let impl_block_indent = leading_indent(impl_node.syntax()).unwrap_or_default(); | ||
54 | |||
55 | ( | ||
56 | impl_block_indent.to_owned(), | ||
57 | first_item_indent.unwrap_or_else(|| impl_block_indent.to_owned() + DEFAULT_INDENT), | ||
58 | ) | ||
59 | }; | ||
60 | |||
61 | let changed_range = { | ||
62 | let children = impl_item_list.syntax().children(); | ||
63 | let last_whitespace = children.filter_map(ast::Whitespace::cast).last(); | ||
64 | |||
65 | last_whitespace.map(|w| w.syntax().range()).unwrap_or_else(|| { | ||
66 | let in_brackets = impl_item_list.syntax().range().end() - TextUnit::of_str("}"); | ||
67 | TextRange::from_to(in_brackets, in_brackets) | ||
68 | }) | ||
69 | }; | ||
70 | |||
71 | let func_bodies = format!("\n{}", missing_fns.into_iter().map(build_func_body).join("\n")); | ||
72 | let trailing_whitespace = format!("\n{}", parent_indent); | ||
73 | let func_bodies = reindent(&func_bodies, &indent) + &trailing_whitespace; | ||
74 | |||
75 | let replaced_text_range = TextUnit::of_str(&func_bodies); | ||
76 | |||
77 | edit.replace(changed_range, func_bodies); | ||
78 | edit.set_cursor( | ||
79 | changed_range.start() + replaced_text_range - TextUnit::of_str(&trailing_whitespace), | ||
80 | ); | ||
81 | }); | ||
82 | |||
83 | ctx.build() | ||
84 | } | ||
85 | |||
86 | /// Given an `ast::ImplBlock`, resolves the target trait (the one being | ||
87 | /// implemented) to a `ast::TraitDef`. | ||
88 | fn resolve_target_trait_def( | ||
89 | db: &impl HirDatabase, | ||
90 | resolver: &Resolver, | ||
91 | impl_block: &ast::ImplBlock, | ||
92 | ) -> Option<TreeArc<ast::TraitDef>> { | ||
93 | let ast_path = impl_block.target_trait().map(AstNode::syntax).and_then(ast::PathType::cast)?; | ||
94 | let hir_path = ast_path.path().and_then(hir::Path::from_ast)?; | ||
95 | |||
96 | match resolver.resolve_path(db, &hir_path).take_types() { | ||
97 | Some(hir::Resolution::Def(hir::ModuleDef::Trait(def))) => Some(def.source(db).1), | ||
98 | _ => None, | ||
99 | } | ||
100 | } | ||
101 | |||
102 | fn build_func_body(def: &ast::FnDef) -> String { | ||
103 | let mut buf = String::new(); | ||
104 | |||
105 | for child in def.syntax().children() { | ||
106 | if child.kind() == SyntaxKind::SEMI { | ||
107 | buf.push_str(" { unimplemented!() }") | ||
108 | } else { | ||
109 | child.text().push_to(&mut buf); | ||
110 | } | ||
111 | } | ||
112 | |||
113 | buf.trim_end().to_string() | ||
114 | } | ||
115 | |||
116 | #[cfg(test)] | ||
117 | mod tests { | ||
118 | use super::*; | ||
119 | use crate::helpers::{check_assist, check_assist_not_applicable}; | ||
120 | |||
121 | #[test] | ||
122 | fn test_add_missing_impl_members() { | ||
123 | check_assist( | ||
124 | add_missing_impl_members, | ||
125 | " | ||
126 | trait Foo { | ||
127 | fn foo(&self); | ||
128 | fn bar(&self); | ||
129 | fn baz(&self); | ||
130 | } | ||
131 | |||
132 | struct S; | ||
133 | |||
134 | impl Foo for S { | ||
135 | fn bar(&self) {} | ||
136 | <|> | ||
137 | }", | ||
138 | " | ||
139 | trait Foo { | ||
140 | fn foo(&self); | ||
141 | fn bar(&self); | ||
142 | fn baz(&self); | ||
143 | } | ||
144 | |||
145 | struct S; | ||
146 | |||
147 | impl Foo for S { | ||
148 | fn bar(&self) {} | ||
149 | fn foo(&self) { unimplemented!() } | ||
150 | fn baz(&self) { unimplemented!() }<|> | ||
151 | }", | ||
152 | ); | ||
153 | } | ||
154 | |||
155 | #[test] | ||
156 | fn test_copied_overriden_members() { | ||
157 | check_assist( | ||
158 | add_missing_impl_members, | ||
159 | " | ||
160 | trait Foo { | ||
161 | fn foo(&self); | ||
162 | fn bar(&self) -> bool { true } | ||
163 | fn baz(&self) -> u32 { 42 } | ||
164 | } | ||
165 | |||
166 | struct S; | ||
167 | |||
168 | impl Foo for S { | ||
169 | fn bar(&self) {} | ||
170 | <|> | ||
171 | }", | ||
172 | " | ||
173 | trait Foo { | ||
174 | fn foo(&self); | ||
175 | fn bar(&self) -> bool { true } | ||
176 | fn baz(&self) -> u32 { 42 } | ||
177 | } | ||
178 | |||
179 | struct S; | ||
180 | |||
181 | impl Foo for S { | ||
182 | fn bar(&self) {} | ||
183 | fn foo(&self) { unimplemented!() } | ||
184 | fn baz(&self) -> u32 { 42 }<|> | ||
185 | }", | ||
186 | ); | ||
187 | } | ||
188 | |||
189 | #[test] | ||
190 | fn test_empty_impl_block() { | ||
191 | check_assist( | ||
192 | add_missing_impl_members, | ||
193 | " | ||
194 | trait Foo { fn foo(&self); } | ||
195 | struct S; | ||
196 | impl Foo for S {<|>}", | ||
197 | " | ||
198 | trait Foo { fn foo(&self); } | ||
199 | struct S; | ||
200 | impl Foo for S { | ||
201 | fn foo(&self) { unimplemented!() }<|> | ||
202 | }", | ||
203 | ); | ||
204 | } | ||
205 | |||
206 | #[test] | ||
207 | fn test_cursor_after_empty_impl_block() { | ||
208 | check_assist( | ||
209 | add_missing_impl_members, | ||
210 | " | ||
211 | trait Foo { fn foo(&self); } | ||
212 | struct S; | ||
213 | impl Foo for S {}<|>", | ||
214 | " | ||
215 | trait Foo { fn foo(&self); } | ||
216 | struct S; | ||
217 | impl Foo for S { | ||
218 | fn foo(&self) { unimplemented!() }<|> | ||
219 | }", | ||
220 | ) | ||
221 | } | ||
222 | |||
223 | #[test] | ||
224 | fn test_empty_trait() { | ||
225 | check_assist_not_applicable( | ||
226 | add_missing_impl_members, | ||
227 | " | ||
228 | trait Foo; | ||
229 | struct S; | ||
230 | impl Foo for S { <|> }", | ||
231 | ) | ||
232 | } | ||
233 | |||
234 | #[test] | ||
235 | fn test_ignore_unnamed_trait_members() { | ||
236 | check_assist( | ||
237 | add_missing_impl_members, | ||
238 | " | ||
239 | trait Foo { | ||
240 | fn (arg: u32); | ||
241 | fn valid(some: u32) -> bool { false } | ||
242 | } | ||
243 | struct S; | ||
244 | impl Foo for S { <|> }", | ||
245 | " | ||
246 | trait Foo { | ||
247 | fn (arg: u32); | ||
248 | fn valid(some: u32) -> bool { false } | ||
249 | } | ||
250 | struct S; | ||
251 | impl Foo for S { | ||
252 | fn valid(some: u32) -> bool { false }<|> | ||
253 | }", | ||
254 | ) | ||
255 | } | ||
256 | |||
257 | #[test] | ||
258 | fn test_indented_impl_block() { | ||
259 | check_assist( | ||
260 | add_missing_impl_members, | ||
261 | " | ||
262 | trait Foo { | ||
263 | fn valid(some: u32) -> bool { false } | ||
264 | } | ||
265 | struct S; | ||
266 | |||
267 | mod my_mod { | ||
268 | impl crate::Foo for S { <|> } | ||
269 | }", | ||
270 | " | ||
271 | trait Foo { | ||
272 | fn valid(some: u32) -> bool { false } | ||
273 | } | ||
274 | struct S; | ||
275 | |||
276 | mod my_mod { | ||
277 | impl crate::Foo for S { | ||
278 | fn valid(some: u32) -> bool { false }<|> | ||
279 | } | ||
280 | }", | ||
281 | ) | ||
282 | } | ||
283 | } | ||