Merge #7272

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



Co-authored-by: Lukas Wirth <lukastw97@gmail.com>

Author: bors[bot]

crates/assists/src/assist_context.rs

@@ -10,7 +10,7 @@ use ide_db::{
 };
 use ide_db::{
     label::Label,
-    source_change::{FileSystemEdit, SourceChange, SourceFileEdit},
+    source_change::{FileSystemEdit, SourceChange},
     RootDatabase,
 };
 use syntax::{
@@ -180,20 +180,12 @@ impl Assists {
 pub(crate) struct AssistBuilder {
     edit: TextEditBuilder,
     file_id: FileId,
-    is_snippet: bool,
-    source_file_edits: Vec<SourceFileEdit>,
-    file_system_edits: Vec<FileSystemEdit>,
+    source_change: SourceChange,
 }
 
 impl AssistBuilder {
     pub(crate) fn new(file_id: FileId) -> AssistBuilder {
-        AssistBuilder {
-            edit: TextEdit::builder(),
-            file_id,
-            is_snippet: false,
-            source_file_edits: Vec::default(),
-            file_system_edits: Vec::default(),
-        }
+        AssistBuilder { edit: TextEdit::builder(), file_id, source_change: SourceChange::default() }
     }
 
     pub(crate) fn edit_file(&mut self, file_id: FileId) {
@@ -204,15 +196,7 @@ impl AssistBuilder {
     fn commit(&mut self) {
         let edit = mem::take(&mut self.edit).finish();
         if !edit.is_empty() {
-            match self.source_file_edits.binary_search_by_key(&self.file_id, |edit| edit.file_id) {
-                Ok(idx) => self.source_file_edits[idx]
-                    .edit
-                    .union(edit)
-                    .expect("overlapping edits for same file"),
-                Err(idx) => self
-                    .source_file_edits
-                    .insert(idx, SourceFileEdit { file_id: self.file_id, edit }),
-            }
+            self.source_change.insert_source_edit(self.file_id, edit);
         }
     }
 
@@ -231,7 +215,7 @@ impl AssistBuilder {
         offset: TextSize,
         snippet: impl Into<String>,
     ) {
-        self.is_snippet = true;
+        self.source_change.is_snippet = true;
         self.insert(offset, snippet);
     }
     /// Replaces specified `range` of text with a given string.
@@ -245,7 +229,7 @@ impl AssistBuilder {
         range: TextRange,
         snippet: impl Into<String>,
     ) {
-        self.is_snippet = true;
+        self.source_change.is_snippet = true;
         self.replace(range, snippet);
     }
     pub(crate) fn replace_ast<N: AstNode>(&mut self, old: N, new: N) {
@@ -260,15 +244,11 @@ impl AssistBuilder {
     pub(crate) fn create_file(&mut self, dst: AnchoredPathBuf, content: impl Into<String>) {
         let file_system_edit =
             FileSystemEdit::CreateFile { dst: dst.clone(), initial_contents: content.into() };
-        self.file_system_edits.push(file_system_edit);
+        self.source_change.push_file_system_edit(file_system_edit);
     }
 
     fn finish(mut self) -> SourceChange {
         self.commit();
-        SourceChange {
-            source_file_edits: mem::take(&mut self.source_file_edits),
-            file_system_edits: mem::take(&mut self.file_system_edits),
-            is_snippet: self.is_snippet,
-        }
+        mem::take(&mut self.source_change)
     }
 }

crates/assists/src/tests.rs

@@ -80,10 +80,8 @@ fn check_doc_test(assist_id: &str, before: &str, after: &str) {
     let actual = {
         let source_change = assist.source_change.unwrap();
         let mut actual = before;
-        for source_file_edit in source_change.source_file_edits {
-            if source_file_edit.file_id == file_id {
-                source_file_edit.edit.apply(&mut actual)
-            }
+        if let Some(source_file_edit) = source_change.get_source_edit(file_id) {
+            source_file_edit.apply(&mut actual);
         }
         actual
     };
@@ -116,37 +114,33 @@ fn check(handler: Handler, before: &str, expected: ExpectedResult, assist_label:
 
     match (assist, expected) {
         (Some(assist), ExpectedResult::After(after)) => {
-            let mut source_change = assist.source_change.unwrap();
+            let source_change = assist.source_change.unwrap();
             assert!(!source_change.source_file_edits.is_empty());
             let skip_header = source_change.source_file_edits.len() == 1
                 && source_change.file_system_edits.len() == 0;
-            source_change.source_file_edits.sort_by_key(|it| it.file_id);
 
             let mut buf = String::new();
-            for source_file_edit in source_change.source_file_edits {
-                let mut text = db.file_text(source_file_edit.file_id).as_ref().to_owned();
-                source_file_edit.edit.apply(&mut text);
+            for (file_id, edit) in source_change.source_file_edits {
+                let mut text = db.file_text(file_id).as_ref().to_owned();
+                edit.apply(&mut text);
                 if !skip_header {
-                    let sr = db.file_source_root(source_file_edit.file_id);
+                    let sr = db.file_source_root(file_id);
                     let sr = db.source_root(sr);
-                    let path = sr.path_for_file(&source_file_edit.file_id).unwrap();
+                    let path = sr.path_for_file(&file_id).unwrap();
                     format_to!(buf, "//- {}\n", path)
                 }
                 buf.push_str(&text);
             }
 
-            for file_system_edit in source_change.file_system_edits.clone() {
-                match file_system_edit {
-                    FileSystemEdit::CreateFile { dst, initial_contents } => {
-                        let sr = db.file_source_root(dst.anchor);
-                        let sr = db.source_root(sr);
-                        let mut base = sr.path_for_file(&dst.anchor).unwrap().clone();
-                        base.pop();
-                        let created_file_path = format!("{}{}", base.to_string(), &dst.path[1..]);
-                        format_to!(buf, "//- {}\n", created_file_path);
-                        buf.push_str(&initial_contents);
-                    }
-                    _ => (),
+            for file_system_edit in source_change.file_system_edits {
+                if let FileSystemEdit::CreateFile { dst, initial_contents } = file_system_edit {
+                    let sr = db.file_source_root(dst.anchor);
+                    let sr = db.source_root(sr);
+                    let mut base = sr.path_for_file(&dst.anchor).unwrap().clone();
+                    base.pop();
+                    let created_file_path = format!("{}{}", base.to_string(), &dst.path[1..]);
+                    format_to!(buf, "//- {}\n", created_file_path);
+                    buf.push_str(&initial_contents);
                 }
             }
 

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 {

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,
             )),
         ));

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 {

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))
         })
     }