diff options
-rw-r--r-- | crates/assists/src/handlers/generate_enum_match_method.rs | 213 | ||||
-rw-r--r-- | crates/assists/src/handlers/generate_new.rs | 64 | ||||
-rw-r--r-- | crates/assists/src/lib.rs | 2 | ||||
-rw-r--r-- | crates/assists/src/tests/generated.rs | 27 | ||||
-rw-r--r-- | crates/assists/src/utils.rs | 75 |
5 files changed, 317 insertions, 64 deletions
diff --git a/crates/assists/src/handlers/generate_enum_match_method.rs b/crates/assists/src/handlers/generate_enum_match_method.rs new file mode 100644 index 000000000..270b438b7 --- /dev/null +++ b/crates/assists/src/handlers/generate_enum_match_method.rs | |||
@@ -0,0 +1,213 @@ | |||
1 | use stdx::{format_to, to_lower_snake_case}; | ||
2 | use syntax::ast::{self, AstNode, NameOwner}; | ||
3 | use syntax::{ast::VisibilityOwner, T}; | ||
4 | use test_utils::mark; | ||
5 | |||
6 | use crate::{utils::find_struct_impl, AssistContext, AssistId, AssistKind, Assists}; | ||
7 | |||
8 | // Assist: generate_enum_match_method | ||
9 | // | ||
10 | // Generate an `is_` method for an enum variant. | ||
11 | // | ||
12 | // ``` | ||
13 | // enum Version { | ||
14 | // Undefined, | ||
15 | // Minor$0, | ||
16 | // Major, | ||
17 | // } | ||
18 | // ``` | ||
19 | // -> | ||
20 | // ``` | ||
21 | // enum Version { | ||
22 | // Undefined, | ||
23 | // Minor, | ||
24 | // Major, | ||
25 | // } | ||
26 | // | ||
27 | // impl Version { | ||
28 | // fn is_minor(&self) -> bool { | ||
29 | // matches!(self, Self::Minor) | ||
30 | // } | ||
31 | // } | ||
32 | // ``` | ||
33 | pub(crate) fn generate_enum_match_method(acc: &mut Assists, ctx: &AssistContext) -> Option<()> { | ||
34 | let variant = ctx.find_node_at_offset::<ast::Variant>()?; | ||
35 | let variant_name = variant.name()?; | ||
36 | let parent_enum = variant.parent_enum(); | ||
37 | if !matches!(variant.kind(), ast::StructKind::Unit) { | ||
38 | mark::hit!(test_gen_enum_match_on_non_unit_variant_not_implemented); | ||
39 | return None; | ||
40 | } | ||
41 | |||
42 | let fn_name = to_lower_snake_case(&variant_name.to_string()); | ||
43 | |||
44 | // Return early if we've found an existing new fn | ||
45 | let impl_def = find_struct_impl( | ||
46 | &ctx, | ||
47 | &ast::AdtDef::Enum(parent_enum.clone()), | ||
48 | format!("is_{}", fn_name).as_str(), | ||
49 | )?; | ||
50 | |||
51 | let target = variant.syntax().text_range(); | ||
52 | acc.add( | ||
53 | AssistId("generate_enum_match_method", AssistKind::Generate), | ||
54 | "Generate an `is_` method for an enum variant", | ||
55 | target, | ||
56 | |builder| { | ||
57 | let mut buf = String::with_capacity(512); | ||
58 | |||
59 | if impl_def.is_some() { | ||
60 | buf.push('\n'); | ||
61 | } | ||
62 | |||
63 | let vis = parent_enum.visibility().map_or(String::new(), |v| format!("{} ", v)); | ||
64 | |||
65 | format_to!( | ||
66 | buf, | ||
67 | " {}fn is_{}(&self) -> bool {{ | ||
68 | matches!(self, Self::{}) | ||
69 | }}", | ||
70 | vis, | ||
71 | fn_name, | ||
72 | variant_name | ||
73 | ); | ||
74 | |||
75 | let start_offset = impl_def | ||
76 | .and_then(|impl_def| { | ||
77 | buf.push('\n'); | ||
78 | let start = impl_def | ||
79 | .syntax() | ||
80 | .descendants_with_tokens() | ||
81 | .find(|t| t.kind() == T!['{'])? | ||
82 | .text_range() | ||
83 | .end(); | ||
84 | |||
85 | Some(start) | ||
86 | }) | ||
87 | .unwrap_or_else(|| { | ||
88 | buf = generate_impl_text(&parent_enum, &buf); | ||
89 | parent_enum.syntax().text_range().end() | ||
90 | }); | ||
91 | |||
92 | builder.insert(start_offset, buf); | ||
93 | }, | ||
94 | ) | ||
95 | } | ||
96 | |||
97 | // Generates the surrounding `impl Type { <code> }` including type and lifetime | ||
98 | // parameters | ||
99 | fn generate_impl_text(strukt: &ast::Enum, code: &str) -> String { | ||
100 | let mut buf = String::with_capacity(code.len()); | ||
101 | buf.push_str("\n\nimpl "); | ||
102 | buf.push_str(strukt.name().unwrap().text()); | ||
103 | format_to!(buf, " {{\n{}\n}}", code); | ||
104 | buf | ||
105 | } | ||
106 | |||
107 | #[cfg(test)] | ||
108 | mod tests { | ||
109 | use test_utils::mark; | ||
110 | |||
111 | use crate::tests::{check_assist, check_assist_not_applicable}; | ||
112 | |||
113 | use super::*; | ||
114 | |||
115 | fn check_not_applicable(ra_fixture: &str) { | ||
116 | check_assist_not_applicable(generate_enum_match_method, ra_fixture) | ||
117 | } | ||
118 | |||
119 | #[test] | ||
120 | fn test_generate_enum_match_from_variant() { | ||
121 | check_assist( | ||
122 | generate_enum_match_method, | ||
123 | r#" | ||
124 | enum Variant { | ||
125 | Undefined, | ||
126 | Minor$0, | ||
127 | Major, | ||
128 | }"#, | ||
129 | r#"enum Variant { | ||
130 | Undefined, | ||
131 | Minor, | ||
132 | Major, | ||
133 | } | ||
134 | |||
135 | impl Variant { | ||
136 | fn is_minor(&self) -> bool { | ||
137 | matches!(self, Self::Minor) | ||
138 | } | ||
139 | }"#, | ||
140 | ); | ||
141 | } | ||
142 | |||
143 | #[test] | ||
144 | fn test_generate_enum_match_already_implemented() { | ||
145 | check_not_applicable( | ||
146 | r#" | ||
147 | enum Variant { | ||
148 | Undefined, | ||
149 | Minor$0, | ||
150 | Major, | ||
151 | } | ||
152 | |||
153 | impl Variant { | ||
154 | fn is_minor(&self) -> bool { | ||
155 | matches!(self, Self::Minor) | ||
156 | } | ||
157 | }"#, | ||
158 | ); | ||
159 | } | ||
160 | |||
161 | #[test] | ||
162 | fn test_add_from_impl_no_element() { | ||
163 | mark::check!(test_gen_enum_match_on_non_unit_variant_not_implemented); | ||
164 | check_not_applicable( | ||
165 | r#" | ||
166 | enum Variant { | ||
167 | Undefined, | ||
168 | Minor(u32)$0, | ||
169 | Major, | ||
170 | }"#, | ||
171 | ); | ||
172 | } | ||
173 | |||
174 | #[test] | ||
175 | fn test_generate_enum_match_from_variant_with_one_variant() { | ||
176 | check_assist( | ||
177 | generate_enum_match_method, | ||
178 | r#"enum Variant { Undefi$0ned }"#, | ||
179 | r#" | ||
180 | enum Variant { Undefined } | ||
181 | |||
182 | impl Variant { | ||
183 | fn is_undefined(&self) -> bool { | ||
184 | matches!(self, Self::Undefined) | ||
185 | } | ||
186 | }"#, | ||
187 | ); | ||
188 | } | ||
189 | |||
190 | #[test] | ||
191 | fn test_generate_enum_match_from_variant_with_visibility_marker() { | ||
192 | check_assist( | ||
193 | generate_enum_match_method, | ||
194 | r#" | ||
195 | pub(crate) enum Variant { | ||
196 | Undefined, | ||
197 | Minor$0, | ||
198 | Major, | ||
199 | }"#, | ||
200 | r#"pub(crate) enum Variant { | ||
201 | Undefined, | ||
202 | Minor, | ||
203 | Major, | ||
204 | } | ||
205 | |||
206 | impl Variant { | ||
207 | pub(crate) fn is_minor(&self) -> bool { | ||
208 | matches!(self, Self::Minor) | ||
209 | } | ||
210 | }"#, | ||
211 | ); | ||
212 | } | ||
213 | } | ||
diff --git a/crates/assists/src/handlers/generate_new.rs b/crates/assists/src/handlers/generate_new.rs index b7390855a..84832273f 100644 --- a/crates/assists/src/handlers/generate_new.rs +++ b/crates/assists/src/handlers/generate_new.rs | |||
@@ -1,4 +1,3 @@ | |||
1 | use hir::Adt; | ||
2 | use itertools::Itertools; | 1 | use itertools::Itertools; |
3 | use stdx::format_to; | 2 | use stdx::format_to; |
4 | use syntax::{ | 3 | use syntax::{ |
@@ -6,7 +5,7 @@ use syntax::{ | |||
6 | SmolStr, T, | 5 | SmolStr, T, |
7 | }; | 6 | }; |
8 | 7 | ||
9 | use crate::{AssistContext, AssistId, AssistKind, Assists}; | 8 | use crate::{utils::find_struct_impl, AssistContext, AssistId, AssistKind, Assists}; |
10 | 9 | ||
11 | // Assist: generate_new | 10 | // Assist: generate_new |
12 | // | 11 | // |
@@ -38,7 +37,7 @@ pub(crate) fn generate_new(acc: &mut Assists, ctx: &AssistContext) -> Option<()> | |||
38 | }; | 37 | }; |
39 | 38 | ||
40 | // Return early if we've found an existing new fn | 39 | // Return early if we've found an existing new fn |
41 | let impl_def = find_struct_impl(&ctx, &strukt)?; | 40 | let impl_def = find_struct_impl(&ctx, &ast::AdtDef::Struct(strukt.clone()), "new")?; |
42 | 41 | ||
43 | let target = strukt.syntax().text_range(); | 42 | let target = strukt.syntax().text_range(); |
44 | acc.add(AssistId("generate_new", AssistKind::Generate), "Generate `new`", target, |builder| { | 43 | acc.add(AssistId("generate_new", AssistKind::Generate), "Generate `new`", target, |builder| { |
@@ -111,65 +110,6 @@ fn generate_impl_text(strukt: &ast::Struct, code: &str) -> String { | |||
111 | buf | 110 | buf |
112 | } | 111 | } |
113 | 112 | ||
114 | // Uses a syntax-driven approach to find any impl blocks for the struct that | ||
115 | // exist within the module/file | ||
116 | // | ||
117 | // Returns `None` if we've found an existing `new` fn | ||
118 | // | ||
119 | // FIXME: change the new fn checking to a more semantic approach when that's more | ||
120 | // viable (e.g. we process proc macros, etc) | ||
121 | fn find_struct_impl(ctx: &AssistContext, strukt: &ast::Struct) -> Option<Option<ast::Impl>> { | ||
122 | let db = ctx.db(); | ||
123 | let module = strukt.syntax().ancestors().find(|node| { | ||
124 | ast::Module::can_cast(node.kind()) || ast::SourceFile::can_cast(node.kind()) | ||
125 | })?; | ||
126 | |||
127 | let struct_def = ctx.sema.to_def(strukt)?; | ||
128 | |||
129 | let block = module.descendants().filter_map(ast::Impl::cast).find_map(|impl_blk| { | ||
130 | let blk = ctx.sema.to_def(&impl_blk)?; | ||
131 | |||
132 | // FIXME: handle e.g. `struct S<T>; impl<U> S<U> {}` | ||
133 | // (we currently use the wrong type parameter) | ||
134 | // also we wouldn't want to use e.g. `impl S<u32>` | ||
135 | let same_ty = match blk.target_ty(db).as_adt() { | ||
136 | Some(def) => def == Adt::Struct(struct_def), | ||
137 | None => false, | ||
138 | }; | ||
139 | let not_trait_impl = blk.target_trait(db).is_none(); | ||
140 | |||
141 | if !(same_ty && not_trait_impl) { | ||
142 | None | ||
143 | } else { | ||
144 | Some(impl_blk) | ||
145 | } | ||
146 | }); | ||
147 | |||
148 | if let Some(ref impl_blk) = block { | ||
149 | if has_new_fn(impl_blk) { | ||
150 | return None; | ||
151 | } | ||
152 | } | ||
153 | |||
154 | Some(block) | ||
155 | } | ||
156 | |||
157 | fn has_new_fn(imp: &ast::Impl) -> bool { | ||
158 | if let Some(il) = imp.assoc_item_list() { | ||
159 | for item in il.assoc_items() { | ||
160 | if let ast::AssocItem::Fn(f) = item { | ||
161 | if let Some(name) = f.name() { | ||
162 | if name.text().eq_ignore_ascii_case("new") { | ||
163 | return true; | ||
164 | } | ||
165 | } | ||
166 | } | ||
167 | } | ||
168 | } | ||
169 | |||
170 | false | ||
171 | } | ||
172 | |||
173 | #[cfg(test)] | 113 | #[cfg(test)] |
174 | mod tests { | 114 | mod tests { |
175 | use crate::tests::{check_assist, check_assist_not_applicable, check_assist_target}; | 115 | use crate::tests::{check_assist, check_assist_not_applicable, check_assist_target}; |
diff --git a/crates/assists/src/lib.rs b/crates/assists/src/lib.rs index 062a902ab..83fbf6986 100644 --- a/crates/assists/src/lib.rs +++ b/crates/assists/src/lib.rs | |||
@@ -127,6 +127,7 @@ mod handlers { | |||
127 | mod flip_trait_bound; | 127 | mod flip_trait_bound; |
128 | mod generate_default_from_enum_variant; | 128 | mod generate_default_from_enum_variant; |
129 | mod generate_derive; | 129 | mod generate_derive; |
130 | mod generate_enum_match_method; | ||
130 | mod generate_from_impl_for_enum; | 131 | mod generate_from_impl_for_enum; |
131 | mod generate_function; | 132 | mod generate_function; |
132 | mod generate_impl; | 133 | mod generate_impl; |
@@ -185,6 +186,7 @@ mod handlers { | |||
185 | flip_trait_bound::flip_trait_bound, | 186 | flip_trait_bound::flip_trait_bound, |
186 | generate_default_from_enum_variant::generate_default_from_enum_variant, | 187 | generate_default_from_enum_variant::generate_default_from_enum_variant, |
187 | generate_derive::generate_derive, | 188 | generate_derive::generate_derive, |
189 | generate_enum_match_method::generate_enum_match_method, | ||
188 | generate_from_impl_for_enum::generate_from_impl_for_enum, | 190 | generate_from_impl_for_enum::generate_from_impl_for_enum, |
189 | generate_function::generate_function, | 191 | generate_function::generate_function, |
190 | generate_impl::generate_impl, | 192 | generate_impl::generate_impl, |
diff --git a/crates/assists/src/tests/generated.rs b/crates/assists/src/tests/generated.rs index e84f208a3..960815bd9 100644 --- a/crates/assists/src/tests/generated.rs +++ b/crates/assists/src/tests/generated.rs | |||
@@ -460,6 +460,33 @@ struct Point { | |||
460 | } | 460 | } |
461 | 461 | ||
462 | #[test] | 462 | #[test] |
463 | fn doctest_generate_enum_match_method() { | ||
464 | check_doc_test( | ||
465 | "generate_enum_match_method", | ||
466 | r#####" | ||
467 | enum Version { | ||
468 | Undefined, | ||
469 | Minor$0, | ||
470 | Major, | ||
471 | } | ||
472 | "#####, | ||
473 | r#####" | ||
474 | enum Version { | ||
475 | Undefined, | ||
476 | Minor, | ||
477 | Major, | ||
478 | } | ||
479 | |||
480 | impl Version { | ||
481 | fn is_minor(&self) -> bool { | ||
482 | matches!(self, Self::Minor) | ||
483 | } | ||
484 | } | ||
485 | "#####, | ||
486 | ) | ||
487 | } | ||
488 | |||
489 | #[test] | ||
463 | fn doctest_generate_from_impl_for_enum() { | 490 | fn doctest_generate_from_impl_for_enum() { |
464 | check_doc_test( | 491 | check_doc_test( |
465 | "generate_from_impl_for_enum", | 492 | "generate_from_impl_for_enum", |
diff --git a/crates/assists/src/utils.rs b/crates/assists/src/utils.rs index 4e762e18b..3842558d8 100644 --- a/crates/assists/src/utils.rs +++ b/crates/assists/src/utils.rs | |||
@@ -2,7 +2,7 @@ | |||
2 | 2 | ||
3 | use std::ops; | 3 | use std::ops; |
4 | 4 | ||
5 | use hir::HasSource; | 5 | use hir::{Adt, HasSource}; |
6 | use ide_db::{helpers::SnippetCap, RootDatabase}; | 6 | use ide_db::{helpers::SnippetCap, RootDatabase}; |
7 | use itertools::Itertools; | 7 | use itertools::Itertools; |
8 | use syntax::{ | 8 | use syntax::{ |
@@ -15,7 +15,10 @@ use syntax::{ | |||
15 | SyntaxNode, TextSize, T, | 15 | SyntaxNode, TextSize, T, |
16 | }; | 16 | }; |
17 | 17 | ||
18 | use crate::ast_transform::{self, AstTransform, QualifyPaths, SubstituteTypeParams}; | 18 | use crate::{ |
19 | assist_context::AssistContext, | ||
20 | ast_transform::{self, AstTransform, QualifyPaths, SubstituteTypeParams}, | ||
21 | }; | ||
19 | 22 | ||
20 | pub(crate) fn unwrap_trivial_block(block: ast::BlockExpr) -> ast::Expr { | 23 | pub(crate) fn unwrap_trivial_block(block: ast::BlockExpr) -> ast::Expr { |
21 | extract_trivial_expression(&block) | 24 | extract_trivial_expression(&block) |
@@ -267,3 +270,71 @@ pub(crate) fn does_pat_match_variant(pat: &ast::Pat, var: &ast::Pat) -> bool { | |||
267 | 270 | ||
268 | pat_head == var_head | 271 | pat_head == var_head |
269 | } | 272 | } |
273 | |||
274 | // Uses a syntax-driven approach to find any impl blocks for the struct that | ||
275 | // exist within the module/file | ||
276 | // | ||
277 | // Returns `None` if we've found an existing `new` fn | ||
278 | // | ||
279 | // FIXME: change the new fn checking to a more semantic approach when that's more | ||
280 | // viable (e.g. we process proc macros, etc) | ||
281 | pub(crate) fn find_struct_impl( | ||
282 | ctx: &AssistContext, | ||
283 | strukt: &ast::AdtDef, | ||
284 | name: &str, | ||
285 | ) -> Option<Option<ast::Impl>> { | ||
286 | let db = ctx.db(); | ||
287 | let module = strukt.syntax().ancestors().find(|node| { | ||
288 | ast::Module::can_cast(node.kind()) || ast::SourceFile::can_cast(node.kind()) | ||
289 | })?; | ||
290 | |||
291 | let struct_def = match strukt { | ||
292 | ast::AdtDef::Enum(e) => Adt::Enum(ctx.sema.to_def(e)?), | ||
293 | ast::AdtDef::Struct(s) => Adt::Struct(ctx.sema.to_def(s)?), | ||
294 | ast::AdtDef::Union(u) => Adt::Union(ctx.sema.to_def(u)?), | ||
295 | }; | ||
296 | |||
297 | let block = module.descendants().filter_map(ast::Impl::cast).find_map(|impl_blk| { | ||
298 | let blk = ctx.sema.to_def(&impl_blk)?; | ||
299 | |||
300 | // FIXME: handle e.g. `struct S<T>; impl<U> S<U> {}` | ||
301 | // (we currently use the wrong type parameter) | ||
302 | // also we wouldn't want to use e.g. `impl S<u32>` | ||
303 | |||
304 | let same_ty = match blk.target_ty(db).as_adt() { | ||
305 | Some(def) => def == struct_def, | ||
306 | None => false, | ||
307 | }; | ||
308 | let not_trait_impl = blk.target_trait(db).is_none(); | ||
309 | |||
310 | if !(same_ty && not_trait_impl) { | ||
311 | None | ||
312 | } else { | ||
313 | Some(impl_blk) | ||
314 | } | ||
315 | }); | ||
316 | |||
317 | if let Some(ref impl_blk) = block { | ||
318 | if has_fn(impl_blk, name) { | ||
319 | return None; | ||
320 | } | ||
321 | } | ||
322 | |||
323 | Some(block) | ||
324 | } | ||
325 | |||
326 | fn has_fn(imp: &ast::Impl, rhs_name: &str) -> bool { | ||
327 | if let Some(il) = imp.assoc_item_list() { | ||
328 | for item in il.assoc_items() { | ||
329 | if let ast::AssocItem::Fn(f) = item { | ||
330 | if let Some(name) = f.name() { | ||
331 | if name.text().eq_ignore_ascii_case(rhs_name) { | ||
332 | return true; | ||
333 | } | ||
334 | } | ||
335 | } | ||
336 | } | ||
337 | } | ||
338 | |||
339 | false | ||
340 | } | ||