From a284a0c7cd2e2113a68c5e547ab3d10805dab6fb Mon Sep 17 00:00:00 2001 From: DropDemBits Date: Sun, 26 Mar 2023 17:46:56 -0400 Subject: [PATCH 1/3] internal: Introduce Structured Snippet API --- crates/ide-db/src/source_change.rs | 112 ++++++++++++++++++++++++++++- 1 file changed, 111 insertions(+), 1 deletion(-) diff --git a/crates/ide-db/src/source_change.rs b/crates/ide-db/src/source_change.rs index 936354f296..1cc7be6813 100644 --- a/crates/ide-db/src/source_change.rs +++ b/crates/ide-db/src/source_change.rs @@ -7,7 +7,7 @@ use std::{collections::hash_map::Entry, iter, mem}; use base_db::{AnchoredPathBuf, FileId}; use stdx::{hash::NoHashHashMap, never}; -use syntax::{algo, AstNode, SyntaxNode, SyntaxNodePtr, TextRange, TextSize}; +use syntax::{algo, ast, ted, AstNode, SyntaxNode, SyntaxNodePtr, TextRange, TextSize}; use text_edit::{TextEdit, TextEditBuilder}; use crate::SnippetCap; @@ -99,6 +99,8 @@ pub struct SourceChangeBuilder { /// Maps the original, immutable `SyntaxNode` to a `clone_for_update` twin. pub mutated_tree: Option, + /// Keeps track of where to place snippets + pub snippet_builder: Option, } pub struct TreeMutator { @@ -106,6 +108,12 @@ pub struct TreeMutator { mutable_clone: SyntaxNode, } +#[derive(Default)] +pub struct SnippetBuilder { + /// Where to place snippets at + places: Vec, +} + impl TreeMutator { pub fn new(immutable: &SyntaxNode) -> TreeMutator { let immutable = immutable.ancestors().last().unwrap(); @@ -131,6 +139,7 @@ impl SourceChangeBuilder { source_change: SourceChange::default(), trigger_signature_help: false, mutated_tree: None, + snippet_builder: None, } } @@ -140,6 +149,17 @@ impl SourceChangeBuilder { } fn commit(&mut self) { + // Render snippets first so that they get bundled into the tree diff + if let Some(mut snippets) = self.snippet_builder.take() { + // Last snippet always has stop index 0 + let last_stop = snippets.places.pop().unwrap(); + last_stop.place(0); + + for (index, stop) in snippets.places.into_iter().enumerate() { + stop.place(index + 1) + } + } + if let Some(tm) = self.mutated_tree.take() { algo::diff(&tm.immutable, &tm.mutable_clone).into_text_edit(&mut self.edit) } @@ -214,6 +234,33 @@ impl SourceChangeBuilder { self.trigger_signature_help = true; } + /// Adds a tabstop snippet to place the cursor before `node` + pub fn add_tabstop_before(&mut self, _cap: SnippetCap, node: impl AstNode) { + assert!(node.syntax().parent().is_some()); + + let snippet_builder = self.snippet_builder.get_or_insert(SnippetBuilder { places: vec![] }); + snippet_builder.places.push(PlaceSnippet::Before(node.syntax().clone())); + self.source_change.is_snippet = true; + } + + /// Adds a tabstop snippet to place the cursor after `node` + pub fn add_tabstop_after(&mut self, _cap: SnippetCap, node: impl AstNode) { + assert!(node.syntax().parent().is_some()); + + let snippet_builder = self.snippet_builder.get_or_insert(SnippetBuilder { places: vec![] }); + snippet_builder.places.push(PlaceSnippet::After(node.syntax().clone())); + self.source_change.is_snippet = true; + } + + /// Adds a snippet to move the cursor selected over `node` + pub fn add_placeholder_snippet(&mut self, _cap: SnippetCap, node: impl AstNode) { + assert!(node.syntax().parent().is_some()); + + let snippet_builder = self.snippet_builder.get_or_insert(SnippetBuilder { places: vec![] }); + snippet_builder.places.push(PlaceSnippet::Over(node.syntax().clone())); + self.source_change.is_snippet = true; + } + pub fn finish(mut self) -> SourceChange { self.commit(); mem::take(&mut self.source_change) @@ -236,3 +283,66 @@ impl From for SourceChange { } } } + +enum PlaceSnippet { + /// Place a tabstop before a node + Before(SyntaxNode), + /// Place a tabstop before a node + After(SyntaxNode), + /// Place a placeholder snippet in place of the node + Over(SyntaxNode), +} + +impl PlaceSnippet { + /// Places the snippet before or over a node with the given tab stop index + fn place(self, order: usize) { + // ensure the target node is still attached + match &self { + PlaceSnippet::Before(node) | PlaceSnippet::After(node) | PlaceSnippet::Over(node) => { + // node should still be in the tree, but if it isn't + // then it's okay to just ignore this place + if stdx::never!(node.parent().is_none()) { + return; + } + } + } + + match self { + PlaceSnippet::Before(node) => { + ted::insert_raw(ted::Position::before(&node), Self::make_tab_stop(order)); + } + PlaceSnippet::After(node) => { + ted::insert_raw(ted::Position::after(&node), Self::make_tab_stop(order)); + } + PlaceSnippet::Over(node) => { + let position = ted::Position::before(&node); + node.detach(); + + let snippet = ast::SourceFile::parse(&format!("${{{order}:_}}")) + .syntax_node() + .clone_for_update(); + + let placeholder = + snippet.descendants().find_map(ast::UnderscoreExpr::cast).unwrap(); + ted::replace(placeholder.syntax(), node); + + ted::insert_raw(position, snippet); + } + } + } + + fn make_tab_stop(order: usize) -> SyntaxNode { + let stop = ast::SourceFile::parse(&format!("stop!(${order})")) + .syntax_node() + .descendants() + .find_map(ast::TokenTree::cast) + .unwrap() + .syntax() + .clone_for_update(); + + stop.first_token().unwrap().detach(); + stop.last_token().unwrap().detach(); + + stop + } +} From 762eacef74e76d41c7aa5bd714926ce2ad6c50bf Mon Sep 17 00:00:00 2001 From: DropDemBits Date: Sun, 26 Mar 2023 18:08:10 -0400 Subject: [PATCH 2/3] factor out adding a snippet --- crates/ide-db/src/source_change.rs | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/crates/ide-db/src/source_change.rs b/crates/ide-db/src/source_change.rs index 1cc7be6813..04e62a8e91 100644 --- a/crates/ide-db/src/source_change.rs +++ b/crates/ide-db/src/source_change.rs @@ -237,27 +237,24 @@ impl SourceChangeBuilder { /// Adds a tabstop snippet to place the cursor before `node` pub fn add_tabstop_before(&mut self, _cap: SnippetCap, node: impl AstNode) { assert!(node.syntax().parent().is_some()); - - let snippet_builder = self.snippet_builder.get_or_insert(SnippetBuilder { places: vec![] }); - snippet_builder.places.push(PlaceSnippet::Before(node.syntax().clone())); - self.source_change.is_snippet = true; + self.add_snippet(PlaceSnippet::Before(node.syntax().clone())); } /// Adds a tabstop snippet to place the cursor after `node` pub fn add_tabstop_after(&mut self, _cap: SnippetCap, node: impl AstNode) { assert!(node.syntax().parent().is_some()); - - let snippet_builder = self.snippet_builder.get_or_insert(SnippetBuilder { places: vec![] }); - snippet_builder.places.push(PlaceSnippet::After(node.syntax().clone())); - self.source_change.is_snippet = true; + self.add_snippet(PlaceSnippet::After(node.syntax().clone())); } /// Adds a snippet to move the cursor selected over `node` pub fn add_placeholder_snippet(&mut self, _cap: SnippetCap, node: impl AstNode) { assert!(node.syntax().parent().is_some()); + self.add_snippet(PlaceSnippet::Over(node.syntax().clone())) + } + fn add_snippet(&mut self, snippet: PlaceSnippet) { let snippet_builder = self.snippet_builder.get_or_insert(SnippetBuilder { places: vec![] }); - snippet_builder.places.push(PlaceSnippet::Over(node.syntax().clone())); + snippet_builder.places.push(snippet); self.source_change.is_snippet = true; } From 369f4774ddf2511912f70584acbe523bb8b6b6f0 Mon Sep 17 00:00:00 2001 From: DropDemBits Date: Sun, 26 Mar 2023 18:09:36 -0400 Subject: [PATCH 3/3] fix: Move cursor before generated generic --- .../src/handlers/introduce_named_generic.rs | 30 ++++++++++++------- crates/ide-assists/src/tests/generated.rs | 2 +- 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/crates/ide-assists/src/handlers/introduce_named_generic.rs b/crates/ide-assists/src/handlers/introduce_named_generic.rs index 062c816aef..b0d35c02d6 100644 --- a/crates/ide-assists/src/handlers/introduce_named_generic.rs +++ b/crates/ide-assists/src/handlers/introduce_named_generic.rs @@ -1,5 +1,5 @@ use syntax::{ - ast::{self, edit_in_place::GenericParamsOwnerEdit, make, AstNode}, + ast::{self, edit_in_place::GenericParamsOwnerEdit, make, AstNode, HasGenericParams}, ted, }; @@ -14,7 +14,7 @@ use crate::{utils::suggest_name, AssistContext, AssistId, AssistKind, Assists}; // ``` // -> // ``` -// fn foo(bar: B) {} +// fn foo<$0B: Bar>(bar: B) {} // ``` pub(crate) fn introduce_named_generic(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> { let impl_trait_type = ctx.find_node_at_offset::()?; @@ -39,7 +39,15 @@ pub(crate) fn introduce_named_generic(acc: &mut Assists, ctx: &AssistContext<'_> let new_ty = make::ty(&type_param_name).clone_for_update(); ted::replace(impl_trait_type.syntax(), new_ty.syntax()); - fn_.get_or_create_generic_param_list().add_generic_param(type_param.into()) + fn_.get_or_create_generic_param_list().add_generic_param(type_param.into()); + + if let Some(cap) = ctx.config.snippet_cap { + if let Some(generic_param) = + fn_.generic_param_list().and_then(|it| it.generic_params().last()) + { + edit.add_tabstop_before(cap, generic_param); + } + } }, ) } @@ -55,7 +63,7 @@ mod tests { check_assist( introduce_named_generic, r#"fn foo(bar: $0impl Bar) {}"#, - r#"fn foo(bar: B) {}"#, + r#"fn foo(bar: B) {}"#, ); } @@ -64,7 +72,7 @@ mod tests { check_assist( introduce_named_generic, r#"fn foo(bar: $0impl Bar) {}"#, - r#"fn foo(bar: B) {}"#, + r#"fn foo<$0B: Bar>(bar: B) {}"#, ); } @@ -73,7 +81,7 @@ mod tests { check_assist( introduce_named_generic, r#"fn foo(foo: impl Foo, bar: $0impl Bar) {}"#, - r#"fn foo(foo: impl Foo, bar: B) {}"#, + r#"fn foo(foo: impl Foo, bar: B) {}"#, ); } @@ -82,7 +90,7 @@ mod tests { check_assist( introduce_named_generic, r#"fn foo<>(bar: $0impl Bar) {}"#, - r#"fn foo(bar: B) {}"#, + r#"fn foo<$0B: Bar>(bar: B) {}"#, ); } @@ -95,7 +103,7 @@ fn foo< >(bar: $0impl Bar) {} "#, r#" -fn foo(bar: B) {} "#, ); @@ -108,7 +116,7 @@ fn foo(bar: $0impl Bar) {}"#, - r#"fn foo(bar: B) {}"#, + r#"fn foo(bar: B) {}"#, ); } @@ -127,7 +135,7 @@ fn foo< fn foo< G: Foo, F, - H, B: Bar, + H, $0B: Bar, >(bar: B) {} "#, ); @@ -138,7 +146,7 @@ fn foo< check_assist( introduce_named_generic, r#"fn foo(bar: $0impl Foo + Bar) {}"#, - r#"fn foo(bar: F) {}"#, + r#"fn foo<$0F: Foo + Bar>(bar: F) {}"#, ); } } diff --git a/crates/ide-assists/src/tests/generated.rs b/crates/ide-assists/src/tests/generated.rs index aff11367de..48e786b23a 100644 --- a/crates/ide-assists/src/tests/generated.rs +++ b/crates/ide-assists/src/tests/generated.rs @@ -1596,7 +1596,7 @@ fn doctest_introduce_named_generic() { fn foo(bar: $0impl Bar) {} "#####, r#####" -fn foo(bar: B) {} +fn foo<$0B: Bar>(bar: B) {} "#####, ) }