diff options
author | Jonas Schievink <[email protected]> | 2021-03-15 00:39:23 +0000 |
---|---|---|
committer | Jonas Schievink <[email protected]> | 2021-03-15 00:39:41 +0000 |
commit | 8b4cbbb87c6dc946711570096d857603c30a5d8d (patch) | |
tree | 90f05142189ae325232cf28d7ee05509fda0266f /crates/ide/src/diagnostics/unlinked_file.rs | |
parent | 7b1a0d5fb724d3f802fe23f9b4455ffd6d7e114f (diff) |
Redo it properly and add a quickfix
Diffstat (limited to 'crates/ide/src/diagnostics/unlinked_file.rs')
-rw-r--r-- | crates/ide/src/diagnostics/unlinked_file.rs | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/crates/ide/src/diagnostics/unlinked_file.rs b/crates/ide/src/diagnostics/unlinked_file.rs new file mode 100644 index 000000000..f6dc671b9 --- /dev/null +++ b/crates/ide/src/diagnostics/unlinked_file.rs | |||
@@ -0,0 +1,154 @@ | |||
1 | use hir::{ | ||
2 | db::DefDatabase, | ||
3 | diagnostics::{Diagnostic, DiagnosticCode}, | ||
4 | InFile, | ||
5 | }; | ||
6 | use ide_db::{ | ||
7 | base_db::{FileId, FileLoader, SourceDatabase, SourceDatabaseExt}, | ||
8 | source_change::SourceChange, | ||
9 | RootDatabase, | ||
10 | }; | ||
11 | use syntax::{ | ||
12 | ast::{self, ModuleItemOwner, NameOwner}, | ||
13 | AstNode, SyntaxNodePtr, | ||
14 | }; | ||
15 | use text_edit::TextEdit; | ||
16 | |||
17 | use crate::Fix; | ||
18 | |||
19 | use super::fixes::DiagnosticWithFix; | ||
20 | |||
21 | #[derive(Debug)] | ||
22 | pub struct UnlinkedFile { | ||
23 | pub file_id: FileId, | ||
24 | pub node: SyntaxNodePtr, | ||
25 | } | ||
26 | |||
27 | impl Diagnostic for UnlinkedFile { | ||
28 | fn code(&self) -> DiagnosticCode { | ||
29 | DiagnosticCode("unlinked-file") | ||
30 | } | ||
31 | |||
32 | fn message(&self) -> String { | ||
33 | "file not included in module tree".to_string() | ||
34 | } | ||
35 | |||
36 | fn display_source(&self) -> InFile<SyntaxNodePtr> { | ||
37 | InFile::new(self.file_id.into(), self.node.clone()) | ||
38 | } | ||
39 | |||
40 | fn as_any(&self) -> &(dyn std::any::Any + Send + 'static) { | ||
41 | self | ||
42 | } | ||
43 | } | ||
44 | |||
45 | impl DiagnosticWithFix for UnlinkedFile { | ||
46 | fn fix(&self, sema: &hir::Semantics<RootDatabase>) -> Option<Fix> { | ||
47 | // If there's an existing module that could add a `mod` item to include the unlinked file, | ||
48 | // suggest that as a fix. | ||
49 | |||
50 | let source_root = sema.db.source_root(sema.db.file_source_root(self.file_id)); | ||
51 | let our_path = source_root.path_for_file(&self.file_id)?; | ||
52 | let module_name = our_path.name_and_extension()?.0; | ||
53 | |||
54 | // Candidates to look for: | ||
55 | // - `mod.rs` in the same folder | ||
56 | // - we also check `main.rs` and `lib.rs` | ||
57 | // - `$dir.rs` in the parent folder, where `$dir` is the directory containing `self.file_id` | ||
58 | let parent = our_path.parent()?; | ||
59 | let mut paths = | ||
60 | vec![parent.join("mod.rs")?, parent.join("main.rs")?, parent.join("lib.rs")?]; | ||
61 | |||
62 | // `submod/bla.rs` -> `submod.rs` | ||
63 | if let Some(newmod) = (|| { | ||
64 | let name = parent.name_and_extension()?.0; | ||
65 | parent.parent()?.join(&format!("{}.rs", name)) | ||
66 | })() { | ||
67 | paths.push(newmod); | ||
68 | } | ||
69 | |||
70 | for path in &paths { | ||
71 | if let Some(parent_id) = source_root.file_for_path(path) { | ||
72 | for krate in sema.db.relevant_crates(*parent_id).iter() { | ||
73 | let crate_def_map = sema.db.crate_def_map(*krate); | ||
74 | for (_, module) in crate_def_map.modules() { | ||
75 | if module.origin.is_inline() { | ||
76 | // We don't handle inline `mod parent {}`s, they use different paths. | ||
77 | continue; | ||
78 | } | ||
79 | |||
80 | if module.origin.file_id() == Some(*parent_id) { | ||
81 | return make_fix(sema.db, *parent_id, module_name, self.file_id); | ||
82 | } | ||
83 | } | ||
84 | } | ||
85 | } | ||
86 | } | ||
87 | |||
88 | None | ||
89 | } | ||
90 | } | ||
91 | |||
92 | fn make_fix( | ||
93 | db: &RootDatabase, | ||
94 | parent_file_id: FileId, | ||
95 | new_mod_name: &str, | ||
96 | added_file_id: FileId, | ||
97 | ) -> Option<Fix> { | ||
98 | fn is_outline_mod(item: &ast::Item) -> bool { | ||
99 | matches!(item, ast::Item::Module(m) if m.item_list().is_none()) | ||
100 | } | ||
101 | |||
102 | let mod_decl = format!("mod {};", new_mod_name); | ||
103 | let ast: ast::SourceFile = db.parse(parent_file_id).tree(); | ||
104 | |||
105 | let mut builder = TextEdit::builder(); | ||
106 | |||
107 | // If there's an existing `mod m;` statement matching the new one, don't emit a fix (it's | ||
108 | // probably `#[cfg]`d out). | ||
109 | for item in ast.items() { | ||
110 | if let ast::Item::Module(m) = item { | ||
111 | if let Some(name) = m.name() { | ||
112 | if m.item_list().is_none() && name.to_string() == new_mod_name { | ||
113 | cov_mark::hit!(unlinked_file_skip_fix_when_mod_already_exists); | ||
114 | return None; | ||
115 | } | ||
116 | } | ||
117 | } | ||
118 | } | ||
119 | |||
120 | // If there are existing `mod m;` items, append after them (after the first group of them, rather). | ||
121 | match ast | ||
122 | .items() | ||
123 | .skip_while(|item| !is_outline_mod(item)) | ||
124 | .take_while(|item| is_outline_mod(item)) | ||
125 | .last() | ||
126 | { | ||
127 | Some(last) => { | ||
128 | cov_mark::hit!(unlinked_file_append_to_existing_mods); | ||
129 | builder.insert(last.syntax().text_range().end(), format!("\n{}", mod_decl)); | ||
130 | } | ||
131 | None => { | ||
132 | // Prepend before the first item in the file. | ||
133 | match ast.items().next() { | ||
134 | Some(item) => { | ||
135 | cov_mark::hit!(unlinked_file_prepend_before_first_item); | ||
136 | builder.insert(item.syntax().text_range().start(), format!("{}\n\n", mod_decl)); | ||
137 | } | ||
138 | None => { | ||
139 | // No items in the file, so just append at the end. | ||
140 | cov_mark::hit!(unlinked_file_empty_file); | ||
141 | builder.insert(ast.syntax().text_range().end(), format!("{}\n", mod_decl)); | ||
142 | } | ||
143 | } | ||
144 | } | ||
145 | } | ||
146 | |||
147 | let edit = builder.finish(); | ||
148 | let trigger_range = db.parse(added_file_id).tree().syntax().text_range(); | ||
149 | Some(Fix::new( | ||
150 | &format!("Insert `{}`", mod_decl), | ||
151 | SourceChange::from_text_edit(parent_file_id, edit), | ||
152 | trigger_range, | ||
153 | )) | ||
154 | } | ||