diff options
Diffstat (limited to 'crates/ide/src/diagnostics/no_such_field.rs')
-rw-r--r-- | crates/ide/src/diagnostics/no_such_field.rs | 286 |
1 files changed, 286 insertions, 0 deletions
diff --git a/crates/ide/src/diagnostics/no_such_field.rs b/crates/ide/src/diagnostics/no_such_field.rs new file mode 100644 index 000000000..edc63c246 --- /dev/null +++ b/crates/ide/src/diagnostics/no_such_field.rs | |||
@@ -0,0 +1,286 @@ | |||
1 | use hir::{db::AstDatabase, HasSource, HirDisplay, Semantics}; | ||
2 | use ide_db::{base_db::FileId, source_change::SourceChange, RootDatabase}; | ||
3 | use syntax::{ | ||
4 | ast::{self, edit::IndentLevel, make}, | ||
5 | AstNode, | ||
6 | }; | ||
7 | use text_edit::TextEdit; | ||
8 | |||
9 | use crate::{ | ||
10 | diagnostics::{fix, Diagnostic, DiagnosticsContext}, | ||
11 | Assist, | ||
12 | }; | ||
13 | |||
14 | // Diagnostic: no-such-field | ||
15 | // | ||
16 | // This diagnostic is triggered if created structure does not have field provided in record. | ||
17 | pub(super) fn no_such_field(ctx: &DiagnosticsContext<'_>, d: &hir::NoSuchField) -> Diagnostic { | ||
18 | Diagnostic::new( | ||
19 | "no-such-field", | ||
20 | "no such field", | ||
21 | ctx.sema.diagnostics_display_range(d.field.clone().map(|it| it.into())).range, | ||
22 | ) | ||
23 | .with_fixes(fixes(ctx, d)) | ||
24 | } | ||
25 | |||
26 | fn fixes(ctx: &DiagnosticsContext<'_>, d: &hir::NoSuchField) -> Option<Vec<Assist>> { | ||
27 | let root = ctx.sema.db.parse_or_expand(d.field.file_id)?; | ||
28 | missing_record_expr_field_fixes( | ||
29 | &ctx.sema, | ||
30 | d.field.file_id.original_file(ctx.sema.db), | ||
31 | &d.field.value.to_node(&root), | ||
32 | ) | ||
33 | } | ||
34 | |||
35 | fn missing_record_expr_field_fixes( | ||
36 | sema: &Semantics<RootDatabase>, | ||
37 | usage_file_id: FileId, | ||
38 | record_expr_field: &ast::RecordExprField, | ||
39 | ) -> Option<Vec<Assist>> { | ||
40 | let record_lit = ast::RecordExpr::cast(record_expr_field.syntax().parent()?.parent()?)?; | ||
41 | let def_id = sema.resolve_variant(record_lit)?; | ||
42 | let module; | ||
43 | let def_file_id; | ||
44 | let record_fields = match def_id { | ||
45 | hir::VariantDef::Struct(s) => { | ||
46 | module = s.module(sema.db); | ||
47 | let source = s.source(sema.db)?; | ||
48 | def_file_id = source.file_id; | ||
49 | let fields = source.value.field_list()?; | ||
50 | record_field_list(fields)? | ||
51 | } | ||
52 | hir::VariantDef::Union(u) => { | ||
53 | module = u.module(sema.db); | ||
54 | let source = u.source(sema.db)?; | ||
55 | def_file_id = source.file_id; | ||
56 | source.value.record_field_list()? | ||
57 | } | ||
58 | hir::VariantDef::Variant(e) => { | ||
59 | module = e.module(sema.db); | ||
60 | let source = e.source(sema.db)?; | ||
61 | def_file_id = source.file_id; | ||
62 | let fields = source.value.field_list()?; | ||
63 | record_field_list(fields)? | ||
64 | } | ||
65 | }; | ||
66 | let def_file_id = def_file_id.original_file(sema.db); | ||
67 | |||
68 | let new_field_type = sema.type_of_expr(&record_expr_field.expr()?)?; | ||
69 | if new_field_type.is_unknown() { | ||
70 | return None; | ||
71 | } | ||
72 | let new_field = make::record_field( | ||
73 | None, | ||
74 | make::name(&record_expr_field.field_name()?.text()), | ||
75 | make::ty(&new_field_type.display_source_code(sema.db, module.into()).ok()?), | ||
76 | ); | ||
77 | |||
78 | let last_field = record_fields.fields().last()?; | ||
79 | let last_field_syntax = last_field.syntax(); | ||
80 | let indent = IndentLevel::from_node(last_field_syntax); | ||
81 | |||
82 | let mut new_field = new_field.to_string(); | ||
83 | if usage_file_id != def_file_id { | ||
84 | new_field = format!("pub(crate) {}", new_field); | ||
85 | } | ||
86 | new_field = format!("\n{}{}", indent, new_field); | ||
87 | |||
88 | let needs_comma = !last_field_syntax.to_string().ends_with(','); | ||
89 | if needs_comma { | ||
90 | new_field = format!(",{}", new_field); | ||
91 | } | ||
92 | |||
93 | let source_change = SourceChange::from_text_edit( | ||
94 | def_file_id, | ||
95 | TextEdit::insert(last_field_syntax.text_range().end(), new_field), | ||
96 | ); | ||
97 | |||
98 | return Some(vec![fix( | ||
99 | "create_field", | ||
100 | "Create field", | ||
101 | source_change, | ||
102 | record_expr_field.syntax().text_range(), | ||
103 | )]); | ||
104 | |||
105 | fn record_field_list(field_def_list: ast::FieldList) -> Option<ast::RecordFieldList> { | ||
106 | match field_def_list { | ||
107 | ast::FieldList::RecordFieldList(it) => Some(it), | ||
108 | ast::FieldList::TupleFieldList(_) => None, | ||
109 | } | ||
110 | } | ||
111 | } | ||
112 | |||
113 | #[cfg(test)] | ||
114 | mod tests { | ||
115 | use crate::diagnostics::tests::{check_diagnostics, check_fix}; | ||
116 | |||
117 | #[test] | ||
118 | fn no_such_field_diagnostics() { | ||
119 | check_diagnostics( | ||
120 | r#" | ||
121 | struct S { foo: i32, bar: () } | ||
122 | impl S { | ||
123 | fn new() -> S { | ||
124 | S { | ||
125 | //^ Missing structure fields: | ||
126 | //| - bar | ||
127 | foo: 92, | ||
128 | baz: 62, | ||
129 | //^^^^^^^ no such field | ||
130 | } | ||
131 | } | ||
132 | } | ||
133 | "#, | ||
134 | ); | ||
135 | } | ||
136 | #[test] | ||
137 | fn no_such_field_with_feature_flag_diagnostics() { | ||
138 | check_diagnostics( | ||
139 | r#" | ||
140 | //- /lib.rs crate:foo cfg:feature=foo | ||
141 | struct MyStruct { | ||
142 | my_val: usize, | ||
143 | #[cfg(feature = "foo")] | ||
144 | bar: bool, | ||
145 | } | ||
146 | |||
147 | impl MyStruct { | ||
148 | #[cfg(feature = "foo")] | ||
149 | pub(crate) fn new(my_val: usize, bar: bool) -> Self { | ||
150 | Self { my_val, bar } | ||
151 | } | ||
152 | #[cfg(not(feature = "foo"))] | ||
153 | pub(crate) fn new(my_val: usize, _bar: bool) -> Self { | ||
154 | Self { my_val } | ||
155 | } | ||
156 | } | ||
157 | "#, | ||
158 | ); | ||
159 | } | ||
160 | |||
161 | #[test] | ||
162 | fn no_such_field_enum_with_feature_flag_diagnostics() { | ||
163 | check_diagnostics( | ||
164 | r#" | ||
165 | //- /lib.rs crate:foo cfg:feature=foo | ||
166 | enum Foo { | ||
167 | #[cfg(not(feature = "foo"))] | ||
168 | Buz, | ||
169 | #[cfg(feature = "foo")] | ||
170 | Bar, | ||
171 | Baz | ||
172 | } | ||
173 | |||
174 | fn test_fn(f: Foo) { | ||
175 | match f { | ||
176 | Foo::Bar => {}, | ||
177 | Foo::Baz => {}, | ||
178 | } | ||
179 | } | ||
180 | "#, | ||
181 | ); | ||
182 | } | ||
183 | |||
184 | #[test] | ||
185 | fn no_such_field_with_feature_flag_diagnostics_on_struct_lit() { | ||
186 | check_diagnostics( | ||
187 | r#" | ||
188 | //- /lib.rs crate:foo cfg:feature=foo | ||
189 | struct S { | ||
190 | #[cfg(feature = "foo")] | ||
191 | foo: u32, | ||
192 | #[cfg(not(feature = "foo"))] | ||
193 | bar: u32, | ||
194 | } | ||
195 | |||
196 | impl S { | ||
197 | #[cfg(feature = "foo")] | ||
198 | fn new(foo: u32) -> Self { | ||
199 | Self { foo } | ||
200 | } | ||
201 | #[cfg(not(feature = "foo"))] | ||
202 | fn new(bar: u32) -> Self { | ||
203 | Self { bar } | ||
204 | } | ||
205 | fn new2(bar: u32) -> Self { | ||
206 | #[cfg(feature = "foo")] | ||
207 | { Self { foo: bar } } | ||
208 | #[cfg(not(feature = "foo"))] | ||
209 | { Self { bar } } | ||
210 | } | ||
211 | fn new2(val: u32) -> Self { | ||
212 | Self { | ||
213 | #[cfg(feature = "foo")] | ||
214 | foo: val, | ||
215 | #[cfg(not(feature = "foo"))] | ||
216 | bar: val, | ||
217 | } | ||
218 | } | ||
219 | } | ||
220 | "#, | ||
221 | ); | ||
222 | } | ||
223 | |||
224 | #[test] | ||
225 | fn no_such_field_with_type_macro() { | ||
226 | check_diagnostics( | ||
227 | r#" | ||
228 | macro_rules! Type { () => { u32 }; } | ||
229 | struct Foo { bar: Type![] } | ||
230 | |||
231 | impl Foo { | ||
232 | fn new() -> Self { | ||
233 | Foo { bar: 0 } | ||
234 | } | ||
235 | } | ||
236 | "#, | ||
237 | ); | ||
238 | } | ||
239 | |||
240 | #[test] | ||
241 | fn test_add_field_from_usage() { | ||
242 | check_fix( | ||
243 | r" | ||
244 | fn main() { | ||
245 | Foo { bar: 3, baz$0: false}; | ||
246 | } | ||
247 | struct Foo { | ||
248 | bar: i32 | ||
249 | } | ||
250 | ", | ||
251 | r" | ||
252 | fn main() { | ||
253 | Foo { bar: 3, baz: false}; | ||
254 | } | ||
255 | struct Foo { | ||
256 | bar: i32, | ||
257 | baz: bool | ||
258 | } | ||
259 | ", | ||
260 | ) | ||
261 | } | ||
262 | |||
263 | #[test] | ||
264 | fn test_add_field_in_other_file_from_usage() { | ||
265 | check_fix( | ||
266 | r#" | ||
267 | //- /main.rs | ||
268 | mod foo; | ||
269 | |||
270 | fn main() { | ||
271 | foo::Foo { bar: 3, $0baz: false}; | ||
272 | } | ||
273 | //- /foo.rs | ||
274 | struct Foo { | ||
275 | bar: i32 | ||
276 | } | ||
277 | "#, | ||
278 | r#" | ||
279 | struct Foo { | ||
280 | bar: i32, | ||
281 | pub(crate) baz: bool | ||
282 | } | ||
283 | "#, | ||
284 | ) | ||
285 | } | ||
286 | } | ||