Merge #7272

7272: Group file source edits by FileId r=matklad a=Veykril



Co-authored-by: Lukas Wirth <[email protected]>

6 files changed, 132 insertions, 169 deletions

diff --git a/crates/ide/src/diagnostics.rs b/crates/ide/src/diagnostics.rs
index 055c0a79c..2e5395b51 100644
--- a/crates/ide/src/diagnostics.rs
+++ b/crates/ide/src/diagnostics.rs
@@ -13,8 +13,7 @@ use hir::{
     diagnostics::{Diagnostic as _, DiagnosticCode, DiagnosticSinkBuilder},
     Semantics,
 };
-use ide_db::base_db::SourceDatabase;
-use ide_db::RootDatabase;
+use ide_db::{base_db::SourceDatabase, RootDatabase};
 use itertools::Itertools;
 use rustc_hash::FxHashSet;
 use syntax::{
@@ -23,7 +22,7 @@ use syntax::{
 };
 use text_edit::TextEdit;
 
-use crate::{FileId, Label, SourceChange, SourceFileEdit};
+use crate::{FileId, Label, SourceChange};
 
 use self::fixes::DiagnosticWithFix;
 
@@ -220,7 +219,7 @@ fn check_unnecessary_braces_in_use_statement(
             Diagnostic::hint(use_range, "Unnecessary braces in use statement".to_string())
                 .with_fix(Some(Fix::new(
                     "Remove unnecessary braces",
-                    SourceFileEdit { file_id, edit }.into(),
+                    SourceChange::from_text_edit(file_id, edit),
                     use_range,
                 ))),
         );
@@ -265,13 +264,11 @@ mod tests {
             .unwrap();
         let fix = diagnostic.fix.unwrap();
         let actual = {
-            let file_id = fix.source_change.source_file_edits.first().unwrap().file_id;
+            let file_id = *fix.source_change.source_file_edits.keys().next().unwrap();
             let mut actual = analysis.file_text(file_id).unwrap().to_string();
 
-            // Go from the last one to the first one, so that ranges won't be affected by previous edits.
-            // FIXME: https://github.com/rust-analyzer/rust-analyzer/issues/4901#issuecomment-644675309
-            for edit in fix.source_change.source_file_edits.iter().rev() {
-                edit.edit.apply(&mut actual);
+            for edit in fix.source_change.source_file_edits.values() {
+                edit.apply(&mut actual);
             }
             actual
         };
@@ -616,7 +613,7 @@ fn test_fn() {
                             Fix {
                                 label: "Create module",
                                 source_change: SourceChange {
-                                    source_file_edits: [],
+                                    source_file_edits: {},
                                     file_system_edits: [
                                         CreateFile {
                                             dst: AnchoredPathBuf {
diff --git a/crates/ide/src/diagnostics/field_shorthand.rs b/crates/ide/src/diagnostics/field_shorthand.rs
index 16c6ea827..5c89e2170 100644
--- a/crates/ide/src/diagnostics/field_shorthand.rs
+++ b/crates/ide/src/diagnostics/field_shorthand.rs
@@ -1,8 +1,7 @@
 //! Suggests shortening `Foo { field: field }` to `Foo { field }` in both
 //! expressions and patterns.
 
-use ide_db::base_db::FileId;
-use ide_db::source_change::SourceFileEdit;
+use ide_db::{base_db::FileId, source_change::SourceChange};
 use syntax::{ast, match_ast, AstNode, SyntaxNode};
 use text_edit::TextEdit;
 
@@ -50,7 +49,7 @@ fn check_expr_field_shorthand(
             Diagnostic::hint(field_range, "Shorthand struct initialization".to_string()).with_fix(
                 Some(Fix::new(
                     "Use struct shorthand initialization",
-                    SourceFileEdit { file_id, edit }.into(),
+                    SourceChange::from_text_edit(file_id, edit),
                     field_range,
                 )),
             ),
@@ -89,7 +88,7 @@ fn check_pat_field_shorthand(
         acc.push(Diagnostic::hint(field_range, "Shorthand struct pattern".to_string()).with_fix(
             Some(Fix::new(
                 "Use struct field shorthand",
-                SourceFileEdit { file_id, edit }.into(),
+                SourceChange::from_text_edit(file_id, edit),
                 field_range,
             )),
         ));
diff --git a/crates/ide/src/diagnostics/fixes.rs b/crates/ide/src/diagnostics/fixes.rs
index d7ad88ed5..e4335119b 100644
--- a/crates/ide/src/diagnostics/fixes.rs
+++ b/crates/ide/src/diagnostics/fixes.rs
@@ -8,9 +8,9 @@ use hir::{
     },
     HasSource, HirDisplay, InFile, Semantics, VariantDef,
 };
-use ide_db::base_db::{AnchoredPathBuf, FileId};
 use ide_db::{
-    source_change::{FileSystemEdit, SourceFileEdit},
+    base_db::{AnchoredPathBuf, FileId},
+    source_change::{FileSystemEdit, SourceChange},
     RootDatabase,
 };
 use syntax::{
@@ -88,7 +88,7 @@ impl DiagnosticWithFix for MissingFields {
         };
         Some(Fix::new(
             "Fill struct fields",
-            SourceFileEdit { file_id: self.file.original_file(sema.db), edit }.into(),
+            SourceChange::from_text_edit(self.file.original_file(sema.db), edit),
             sema.original_range(&field_list_parent.syntax()).range,
         ))
     }
@@ -101,8 +101,7 @@ impl DiagnosticWithFix for MissingOkOrSomeInTailExpr {
         let tail_expr_range = tail_expr.syntax().text_range();
         let replacement = format!("{}({})", self.required, tail_expr.syntax());
         let edit = TextEdit::replace(tail_expr_range, replacement);
-        let source_change =
-            SourceFileEdit { file_id: self.file.original_file(sema.db), edit }.into();
+        let source_change = SourceChange::from_text_edit(self.file.original_file(sema.db), edit);
         let name = if self.required == "Ok" { "Wrap with Ok" } else { "Wrap with Some" };
         Some(Fix::new(name, source_change, tail_expr_range))
     }
@@ -122,8 +121,7 @@ impl DiagnosticWithFix for RemoveThisSemicolon {
             .text_range();
 
         let edit = TextEdit::delete(semicolon);
-        let source_change =
-            SourceFileEdit { file_id: self.file.original_file(sema.db), edit }.into();
+        let source_change = SourceChange::from_text_edit(self.file.original_file(sema.db), edit);
 
         Some(Fix::new("Remove this semicolon", source_change, semicolon))
     }
@@ -204,15 +202,11 @@ fn missing_record_expr_field_fix(
         new_field = format!(",{}", new_field);
     }
 
-    let source_change = SourceFileEdit {
-        file_id: def_file_id,
-        edit: TextEdit::insert(last_field_syntax.text_range().end(), new_field),
-    };
-    return Some(Fix::new(
-        "Create field",
-        source_change.into(),
-        record_expr_field.syntax().text_range(),
-    ));
+    let source_change = SourceChange::from_text_edit(
+        def_file_id,
+        TextEdit::insert(last_field_syntax.text_range().end(), new_field),
+    );
+    return Some(Fix::new("Create field", source_change, record_expr_field.syntax().text_range()));
 
     fn record_field_list(field_def_list: ast::FieldList) -> Option<ast::RecordFieldList> {
         match field_def_list {
diff --git a/crates/ide/src/lib.rs b/crates/ide/src/lib.rs
index 1e03832ec..afd552008 100644
--- a/crates/ide/src/lib.rs
+++ b/crates/ide/src/lib.rs
@@ -98,7 +98,7 @@ pub use ide_db::{
     label::Label,
     line_index::{LineCol, LineIndex},
     search::SearchScope,
-    source_change::{FileSystemEdit, SourceChange, SourceFileEdit},
+    source_change::{FileSystemEdit, SourceChange},
     symbol_index::Query,
     RootDatabase,
 };
@@ -553,7 +553,7 @@ impl Analysis {
             let rule: ssr::SsrRule = query.parse()?;
             let mut match_finder = ssr::MatchFinder::in_context(db, resolve_context, selections);
             match_finder.add_rule(rule)?;
-            let edits = if parse_only { Vec::new() } else { match_finder.edits() };
+            let edits = if parse_only { Default::default() } else { match_finder.edits() };
             Ok(SourceChange::from(edits))
         })
     }
diff --git a/crates/ide/src/references/rename.rs b/crates/ide/src/references/rename.rs
index c3ae568c2..039efb26f 100644
--- a/crates/ide/src/references/rename.rs
+++ b/crates/ide/src/references/rename.rs
@@ -21,7 +21,7 @@ use text_edit::TextEdit;
 
 use crate::{
     FilePosition, FileSystemEdit, RangeInfo, ReferenceKind, ReferenceSearchResult, SourceChange,
-    SourceFileEdit, TextRange, TextSize,
+    TextRange, TextSize,
 };
 
 type RenameResult<T> = Result<T, RenameError>;
@@ -58,7 +58,7 @@ pub(crate) fn prepare_rename(
         rename_self_to_param(&sema, position, self_token, "dummy")
     } else {
         let RangeInfo { range, .. } = find_all_refs(&sema, position)?;
-        Ok(RangeInfo::new(range, SourceChange::from(vec![])))
+        Ok(RangeInfo::new(range, SourceChange::default()))
     }
     .map(|info| RangeInfo::new(info.range, ()))
 }
@@ -176,7 +176,7 @@ fn source_edit_from_references(
     file_id: FileId,
     references: &[FileReference],
     new_name: &str,
-) -> SourceFileEdit {
+) -> (FileId, TextEdit) {
     let mut edit = TextEdit::builder();
     for reference in references {
         let mut replacement_text = String::new();
@@ -209,8 +209,7 @@ fn source_edit_from_references(
         };
         edit.replace(range, replacement_text);
     }
-
-    SourceFileEdit { file_id, edit: edit.finish() }
+    (file_id, edit.finish())
 }
 
 fn edit_text_range_for_record_field_expr_or_pat(
@@ -250,8 +249,8 @@ fn rename_mod(
     if IdentifierKind::Ident != check_identifier(new_name)? {
         bail!("Invalid name `{0}`: cannot rename module to {0}", new_name);
     }
-    let mut source_file_edits = Vec::new();
-    let mut file_system_edits = Vec::new();
+
+    let mut source_change = SourceChange::default();
 
     let src = module.definition_source(sema.db);
     let file_id = src.file_id.original_file(sema.db);
@@ -265,7 +264,7 @@ fn rename_mod(
             };
             let dst = AnchoredPathBuf { anchor: file_id, path };
             let move_file = FileSystemEdit::MoveFile { src: file_id, dst };
-            file_system_edits.push(move_file);
+            source_change.push_file_system_edit(move_file);
         }
         ModuleSource::Module(..) => {}
     }
@@ -273,20 +272,19 @@ fn rename_mod(
     if let Some(src) = module.declaration_source(sema.db) {
         let file_id = src.file_id.original_file(sema.db);
         let name = src.value.name().unwrap();
-        let edit = SourceFileEdit {
+        source_change.insert_source_edit(
             file_id,
-            edit: TextEdit::replace(name.syntax().text_range(), new_name.into()),
-        };
-        source_file_edits.push(edit);
+            TextEdit::replace(name.syntax().text_range(), new_name.into()),
+        );
     }
 
     let RangeInfo { range, info: refs } = find_all_refs(sema, position)?;
     let ref_edits = refs.references().iter().map(|(&file_id, references)| {
         source_edit_from_references(sema, file_id, references, new_name)
     });
-    source_file_edits.extend(ref_edits);
+    source_change.extend(ref_edits);
 
-    Ok(RangeInfo::new(range, SourceChange::from_edits(source_file_edits, file_system_edits)))
+    Ok(RangeInfo::new(range, source_change))
 }
 
 fn rename_to_self(
@@ -335,20 +333,16 @@ fn rename_to_self(
 
     let RangeInfo { range, info: refs } = find_all_refs(sema, position)?;
 
-    let mut edits = refs
-        .references()
-        .iter()
-        .map(|(&file_id, references)| {
-            source_edit_from_references(sema, file_id, references, "self")
-        })
-        .collect::<Vec<_>>();
-
-    edits.push(SourceFileEdit {
-        file_id: position.file_id,
-        edit: TextEdit::replace(param_range, String::from(self_param)),
-    });
+    let mut source_change = SourceChange::default();
+    source_change.extend(refs.references().iter().map(|(&file_id, references)| {
+        source_edit_from_references(sema, file_id, references, "self")
+    }));
+    source_change.insert_source_edit(
+        position.file_id,
+        TextEdit::replace(param_range, String::from(self_param)),
+    );
 
-    Ok(RangeInfo::new(range, SourceChange::from(edits)))
+    Ok(RangeInfo::new(range, source_change))
 }
 
 fn text_edit_from_self_param(
@@ -402,7 +396,7 @@ fn rename_self_to_param(
         .ok_or_else(|| format_err!("No surrounding method declaration found"))?;
     let search_range = fn_def.syntax().text_range();
 
-    let mut edits: Vec<SourceFileEdit> = vec![];
+    let mut source_change = SourceChange::default();
 
     for (idx, _) in text.match_indices("self") {
         let offset: TextSize = idx.try_into().unwrap();
@@ -416,18 +410,18 @@ fn rename_self_to_param(
             } else {
                 TextEdit::replace(usage.text_range(), String::from(new_name))
             };
-            edits.push(SourceFileEdit { file_id: position.file_id, edit });
+            source_change.insert_source_edit(position.file_id, edit);
         }
     }
 
-    if edits.len() > 1 && ident_kind == IdentifierKind::Underscore {
+    if source_change.source_file_edits.len() > 1 && ident_kind == IdentifierKind::Underscore {
         bail!("Cannot rename reference to `_` as it is being referenced multiple times");
     }
 
     let range = ast::SelfParam::cast(self_token.parent())
         .map_or(self_token.text_range(), |p| p.syntax().text_range());
 
-    Ok(RangeInfo::new(range, SourceChange::from(edits)))
+    Ok(RangeInfo::new(range, source_change))
 }
 
 fn rename_reference(
@@ -464,14 +458,12 @@ fn rename_reference(
         (IdentifierKind::Ident, _) | (IdentifierKind::Underscore, _) => mark::hit!(rename_ident),
     }
 
-    let edit = refs
-        .into_iter()
-        .map(|(file_id, references)| {
-            source_edit_from_references(sema, file_id, &references, new_name)
-        })
-        .collect::<Vec<_>>();
+    let mut source_change = SourceChange::default();
+    source_change.extend(refs.into_iter().map(|(file_id, references)| {
+        source_edit_from_references(sema, file_id, &references, new_name)
+    }));
 
-    Ok(RangeInfo::new(range, SourceChange::from(edit)))
+    Ok(RangeInfo::new(range, source_change))
 }
 
 #[cfg(test)]
@@ -494,8 +486,8 @@ mod tests {
                 let mut text_edit_builder = TextEdit::builder();
                 let mut file_id: Option<FileId> = None;
                 for edit in source_change.info.source_file_edits {
-                    file_id = Some(edit.file_id);
-                    for indel in edit.edit.into_iter() {
+                    file_id = Some(edit.0);
+                    for indel in edit.1.into_iter() {
                         text_edit_builder.replace(indel.delete, indel.insert);
                     }
                 }
@@ -895,21 +887,18 @@ mod foo$0;
                 RangeInfo {
                     range: 4..7,
                     info: SourceChange {
-                        source_file_edits: [
-                            SourceFileEdit {
-                                file_id: FileId(
-                                    1,
-                                ),
-                                edit: TextEdit {
-                                    indels: [
-                                        Indel {
-                                            insert: "foo2",
-                                            delete: 4..7,
-                                        },
-                                    ],
-                                },
+                        source_file_edits: {
+                            FileId(
+                                1,
+                            ): TextEdit {
+                                indels: [
+                                    Indel {
+                                        insert: "foo2",
+                                        delete: 4..7,
+                                    },
+                                ],
                             },
-                        ],
+                        },
                         file_system_edits: [
                             MoveFile {
                                 src: FileId(
@@ -950,34 +939,28 @@ use crate::foo$0::FooContent;
                 RangeInfo {
                     range: 11..14,
                     info: SourceChange {
-                        source_file_edits: [
-                            SourceFileEdit {
-                                file_id: FileId(
-                                    0,
-                                ),
-                                edit: TextEdit {
-                                    indels: [
-                                        Indel {
-                                            insert: "quux",
-                                            delete: 8..11,
-                                        },
-                                    ],
-                                },
+                        source_file_edits: {
+                            FileId(
+                                0,
+                            ): TextEdit {
+                                indels: [
+                                    Indel {
+                                        insert: "quux",
+                                        delete: 8..11,
+                                    },
+                                ],
                             },
-                            SourceFileEdit {
-                                file_id: FileId(
-                                    2,
-                                ),
-                                edit: TextEdit {
-                                    indels: [
-                                        Indel {
-                                            insert: "quux",
-                                            delete: 11..14,
-                                        },
-                                    ],
-                                },
+                            FileId(
+                                2,
+                            ): TextEdit {
+                                indels: [
+                                    Indel {
+                                        insert: "quux",
+                                        delete: 11..14,
+                                    },
+                                ],
                             },
-                        ],
+                        },
                         file_system_edits: [
                             MoveFile {
                                 src: FileId(
@@ -1012,21 +995,18 @@ mod fo$0o;
                 RangeInfo {
                     range: 4..7,
                     info: SourceChange {
-                        source_file_edits: [
-                            SourceFileEdit {
-                                file_id: FileId(
-                                    0,
-                                ),
-                                edit: TextEdit {
-                                    indels: [
-                                        Indel {
-                                            insert: "foo2",
-                                            delete: 4..7,
-                                        },
-                                    ],
-                                },
+                        source_file_edits: {
+                            FileId(
+                                0,
+                            ): TextEdit {
+                                indels: [
+                                    Indel {
+                                        insert: "foo2",
+                                        delete: 4..7,
+                                    },
+                                ],
                             },
-                        ],
+                        },
                         file_system_edits: [
                             MoveFile {
                                 src: FileId(
@@ -1062,21 +1042,18 @@ mod outer { mod fo$0o; }
                 RangeInfo {
                     range: 16..19,
                     info: SourceChange {
-                        source_file_edits: [
-                            SourceFileEdit {
-                                file_id: FileId(
-                                    0,
-                                ),
-                                edit: TextEdit {
-                                    indels: [
-                                        Indel {
-                                            insert: "bar",
-                                            delete: 16..19,
-                                        },
-                                    ],
-                                },
+                        source_file_edits: {
+                            FileId(
+                                0,
+                            ): TextEdit {
+                                indels: [
+                                    Indel {
+                                        insert: "bar",
+                                        delete: 16..19,
+                                    },
+                                ],
                             },
-                        ],
+                        },
                         file_system_edits: [
                             MoveFile {
                                 src: FileId(
@@ -1135,34 +1112,28 @@ pub mod foo$0;
                 RangeInfo {
                     range: 8..11,
                     info: SourceChange {
-                        source_file_edits: [
-                            SourceFileEdit {
-                                file_id: FileId(
-                                    1,
-                                ),
-                                edit: TextEdit {
-                                    indels: [
-                                        Indel {
-                                            insert: "foo2",
-                                            delete: 8..11,
-                                        },
-                                    ],
-                                },
+                        source_file_edits: {
+                            FileId(
+                                0,
+                            ): TextEdit {
+                                indels: [
+                                    Indel {
+                                        insert: "foo2",
+                                        delete: 27..30,
+                                    },
+                                ],
                             },
-                            SourceFileEdit {
-                                file_id: FileId(
-                                    0,
-                                ),
-                                edit: TextEdit {
-                                    indels: [
-                                        Indel {
-                                            insert: "foo2",
-                                            delete: 27..30,
-                                        },
-                                    ],
-                                },
+                            FileId(
+                                1,
+                            ): TextEdit {
+                                indels: [
+                                    Indel {
+                                        insert: "foo2",
+                                        delete: 8..11,
+                                    },
+                                ],
                             },
-                        ],
+                        },
                         file_system_edits: [
                             MoveFile {
                                 src: FileId(
diff --git a/crates/ide/src/typing.rs b/crates/ide/src/typing.rs
index 88c905003..e3c3aebac 100644
--- a/crates/ide/src/typing.rs
+++ b/crates/ide/src/typing.rs
@@ -15,8 +15,10 @@
 
 mod on_enter;
 
-use ide_db::base_db::{FilePosition, SourceDatabase};
-use ide_db::{source_change::SourceFileEdit, RootDatabase};
+use ide_db::{
+    base_db::{FilePosition, SourceDatabase},
+    RootDatabase,
+};
 use syntax::{
     algo::find_node_at_offset,
     ast::{self, edit::IndentLevel, AstToken},
@@ -56,7 +58,7 @@ pub(crate) fn on_char_typed(
     let file = &db.parse(position.file_id).tree();
     assert_eq!(file.syntax().text().char_at(position.offset), Some(char_typed));
     let edit = on_char_typed_inner(file, position.offset, char_typed)?;
-    Some(SourceFileEdit { file_id: position.file_id, edit }.into())
+    Some(SourceChange::from_text_edit(position.file_id, edit))
 }
 
 fn on_char_typed_inner(file: &SourceFile, offset: TextSize, char_typed: char) -> Option<TextEdit> {