aboutsummaryrefslogtreecommitdiff
path: root/crates/ra_assists/src/handlers/extract_struct_from_enum_variant.rs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/ra_assists/src/handlers/extract_struct_from_enum_variant.rs')
-rw-r--r--crates/ra_assists/src/handlers/extract_struct_from_enum_variant.rs326
1 files changed, 326 insertions, 0 deletions
diff --git a/crates/ra_assists/src/handlers/extract_struct_from_enum_variant.rs b/crates/ra_assists/src/handlers/extract_struct_from_enum_variant.rs
new file mode 100644
index 000000000..2c455a1fd
--- /dev/null
+++ b/crates/ra_assists/src/handlers/extract_struct_from_enum_variant.rs
@@ -0,0 +1,326 @@
1use ra_ide_db::{defs::Definition, search::Reference, RootDatabase};
2use ra_syntax::{
3 algo::find_node_at_offset,
4 ast::{self, AstNode, NameOwner},
5 SourceFile, SyntaxNode, TextRange, TextSize,
6};
7
8use crate::{
9 assist_context::{AssistBuilder, AssistDirector},
10 utils::insert_use_statement,
11 AssistContext, AssistId, Assists,
12};
13use ast::{ArgListOwner, VisibilityOwner};
14use hir::{EnumVariant, Module, ModuleDef, Name};
15use ra_db::FileId;
16use ra_fmt::leading_indent;
17use rustc_hash::FxHashSet;
18
19// Assist: extract_struct_from_enum_variant
20//
21// Extracts a struct from enum variant.
22//
23// ```
24// enum A { <|>One(u32, u32) }
25// ```
26// ->
27// ```
28// struct One(pub u32, pub u32);
29//
30// enum A { One(One) }
31// ```
32pub(crate) fn extract_struct_from_enum_variant(
33 acc: &mut Assists,
34 ctx: &AssistContext,
35) -> Option<()> {
36 let variant = ctx.find_node_at_offset::<ast::EnumVariant>()?;
37 let field_list = match variant.kind() {
38 ast::StructKind::Tuple(field_list) => field_list,
39 _ => return None,
40 };
41 let variant_name = variant.name()?.to_string();
42 let variant_hir = ctx.sema.to_def(&variant)?;
43 if existing_struct_def(ctx.db, &variant_name, &variant_hir) {
44 return None;
45 }
46 let enum_ast = variant.parent_enum();
47 let visibility = enum_ast.visibility();
48 let enum_hir = ctx.sema.to_def(&enum_ast)?;
49 let variant_hir_name = variant_hir.name(ctx.db);
50 let enum_module_def = ModuleDef::from(enum_hir);
51 let current_module = enum_hir.module(ctx.db);
52 let target = variant.syntax().text_range();
53 acc.add_in_multiple_files(
54 AssistId("extract_struct_from_enum_variant"),
55 "Extract struct from enum variant",
56 target,
57 |edit| {
58 let definition = Definition::ModuleDef(ModuleDef::EnumVariant(variant_hir));
59 let res = definition.find_usages(&ctx.db, None);
60 let start_offset = variant.parent_enum().syntax().text_range().start();
61 let mut visited_modules_set = FxHashSet::default();
62 visited_modules_set.insert(current_module);
63 for reference in res {
64 let source_file = ctx.sema.parse(reference.file_range.file_id);
65 update_reference(
66 ctx,
67 edit,
68 reference,
69 &source_file,
70 &enum_module_def,
71 &variant_hir_name,
72 &mut visited_modules_set,
73 );
74 }
75 extract_struct_def(
76 edit,
77 enum_ast.syntax(),
78 &variant_name,
79 &field_list.to_string(),
80 start_offset,
81 ctx.frange.file_id,
82 &visibility,
83 );
84 let list_range = field_list.syntax().text_range();
85 update_variant(edit, &variant_name, ctx.frange.file_id, list_range);
86 },
87 )
88}
89
90fn existing_struct_def(db: &RootDatabase, variant_name: &str, variant: &EnumVariant) -> bool {
91 variant
92 .parent_enum(db)
93 .module(db)
94 .scope(db, None)
95 .into_iter()
96 .any(|(name, _)| name.to_string() == variant_name.to_string())
97}
98
99fn insert_import(
100 ctx: &AssistContext,
101 builder: &mut AssistBuilder,
102 path: &ast::PathExpr,
103 module: &Module,
104 enum_module_def: &ModuleDef,
105 variant_hir_name: &Name,
106) -> Option<()> {
107 let db = ctx.db;
108 let mod_path = module.find_use_path(db, enum_module_def.clone());
109 if let Some(mut mod_path) = mod_path {
110 mod_path.segments.pop();
111 mod_path.segments.push(variant_hir_name.clone());
112 insert_use_statement(path.syntax(), &mod_path, ctx, builder.text_edit_builder());
113 }
114 Some(())
115}
116
117fn extract_struct_def(
118 edit: &mut AssistDirector,
119 enum_ast: &SyntaxNode,
120 variant_name: &str,
121 variant_list: &str,
122 start_offset: TextSize,
123 file_id: FileId,
124 visibility: &Option<ast::Visibility>,
125) -> Option<()> {
126 let visibility_string = if let Some(visibility) = visibility {
127 format!("{} ", visibility.to_string())
128 } else {
129 "".to_string()
130 };
131 let indent = if let Some(indent) = leading_indent(enum_ast) {
132 indent.to_string()
133 } else {
134 "".to_string()
135 };
136 let struct_def = format!(
137 r#"{}struct {}{};
138
139{}"#,
140 visibility_string,
141 variant_name,
142 list_with_visibility(variant_list),
143 indent
144 );
145 edit.perform(file_id, |builder| {
146 builder.insert(start_offset, struct_def);
147 });
148 Some(())
149}
150
151fn update_variant(
152 edit: &mut AssistDirector,
153 variant_name: &str,
154 file_id: FileId,
155 list_range: TextRange,
156) -> Option<()> {
157 let inside_variant_range = TextRange::new(
158 list_range.start().checked_add(TextSize::from(1))?,
159 list_range.end().checked_sub(TextSize::from(1))?,
160 );
161 edit.perform(file_id, |builder| {
162 builder.replace(inside_variant_range, variant_name);
163 });
164 Some(())
165}
166
167fn update_reference(
168 ctx: &AssistContext,
169 edit: &mut AssistDirector,
170 reference: Reference,
171 source_file: &SourceFile,
172 enum_module_def: &ModuleDef,
173 variant_hir_name: &Name,
174 visited_modules_set: &mut FxHashSet<Module>,
175) -> Option<()> {
176 let path_expr: ast::PathExpr = find_node_at_offset::<ast::PathExpr>(
177 source_file.syntax(),
178 reference.file_range.range.start(),
179 )?;
180 let call = path_expr.syntax().parent().and_then(ast::CallExpr::cast)?;
181 let list = call.arg_list()?;
182 let segment = path_expr.path()?.segment()?;
183 let module = ctx.sema.scope(&path_expr.syntax()).module()?;
184 let list_range = list.syntax().text_range();
185 let inside_list_range = TextRange::new(
186 list_range.start().checked_add(TextSize::from(1))?,
187 list_range.end().checked_sub(TextSize::from(1))?,
188 );
189 edit.perform(reference.file_range.file_id, |builder| {
190 if !visited_modules_set.contains(&module) {
191 if insert_import(ctx, builder, &path_expr, &module, enum_module_def, variant_hir_name)
192 .is_some()
193 {
194 visited_modules_set.insert(module);
195 }
196 }
197 builder.replace(inside_list_range, format!("{}{}", segment, list));
198 });
199 Some(())
200}
201
202fn list_with_visibility(list: &str) -> String {
203 list.split(',')
204 .map(|part| {
205 let index = if part.chars().next().unwrap() == '(' { 1usize } else { 0 };
206 let mut mod_part = part.trim().to_string();
207 mod_part.insert_str(index, "pub ");
208 mod_part
209 })
210 .collect::<Vec<String>>()
211 .join(", ")
212}
213
214#[cfg(test)]
215mod tests {
216
217 use crate::{
218 tests::{check_assist, check_assist_not_applicable},
219 utils::FamousDefs,
220 };
221
222 use super::*;
223
224 #[test]
225 fn test_extract_struct_several_fields() {
226 check_assist(
227 extract_struct_from_enum_variant,
228 "enum A { <|>One(u32, u32) }",
229 r#"struct One(pub u32, pub u32);
230
231enum A { One(One) }"#,
232 );
233 }
234
235 #[test]
236 fn test_extract_struct_one_field() {
237 check_assist(
238 extract_struct_from_enum_variant,
239 "enum A { <|>One(u32) }",
240 r#"struct One(pub u32);
241
242enum A { One(One) }"#,
243 );
244 }
245
246 #[test]
247 fn test_extract_struct_pub_visibility() {
248 check_assist(
249 extract_struct_from_enum_variant,
250 "pub enum A { <|>One(u32, u32) }",
251 r#"pub struct One(pub u32, pub u32);
252
253pub enum A { One(One) }"#,
254 );
255 }
256
257 #[test]
258 fn test_extract_struct_with_complex_imports() {
259 check_assist(
260 extract_struct_from_enum_variant,
261 r#"mod my_mod {
262 fn another_fn() {
263 let m = my_other_mod::MyEnum::MyField(1, 1);
264 }
265
266 pub mod my_other_mod {
267 fn another_fn() {
268 let m = MyEnum::MyField(1, 1);
269 }
270
271 pub enum MyEnum {
272 <|>MyField(u8, u8),
273 }
274 }
275}
276
277fn another_fn() {
278 let m = my_mod::my_other_mod::MyEnum::MyField(1, 1);
279}"#,
280 r#"use my_mod::my_other_mod::MyField;
281
282mod my_mod {
283 use my_other_mod::MyField;
284
285 fn another_fn() {
286 let m = my_other_mod::MyEnum::MyField(MyField(1, 1));
287 }
288
289 pub mod my_other_mod {
290 fn another_fn() {
291 let m = MyEnum::MyField(MyField(1, 1));
292 }
293
294 pub struct MyField(pub u8, pub u8);
295
296 pub enum MyEnum {
297 MyField(MyField),
298 }
299 }
300}
301
302fn another_fn() {
303 let m = my_mod::my_other_mod::MyEnum::MyField(MyField(1, 1));
304}"#,
305 );
306 }
307
308 fn check_not_applicable(ra_fixture: &str) {
309 let fixture =
310 format!("//- main.rs crate:main deps:core\n{}\n{}", ra_fixture, FamousDefs::FIXTURE);
311 check_assist_not_applicable(extract_struct_from_enum_variant, &fixture)
312 }
313
314 #[test]
315 fn test_extract_enum_not_applicable_for_element_with_no_fields() {
316 check_not_applicable("enum A { <|>One }");
317 }
318
319 #[test]
320 fn test_extract_enum_not_applicable_if_struct_exists() {
321 check_not_applicable(
322 r#"struct One;
323 enum A { <|>One(u8) }"#,
324 );
325 }
326}