Use snippets in add function

matklad · matklad · commit 8eb3272ad6f7 · 2020-05-20T01:23:05.000+02:00
diff --git a/crates/ra_assists/src/handlers/add_function.rs b/crates/ra_assists/src/handlers/add_function.rs
@@ -10,7 +10,7 @@ use ra_syntax::{
 };
 use rustc_hash::{FxHashMap, FxHashSet};
 
-use crate::{AssistContext, AssistId, Assists};
+use crate::{utils::render_snippet, AssistContext, AssistId, Assists};
 
 // Assist: add_function
 //
@@ -33,7 +33,7 @@ use crate::{AssistContext, AssistId, Assists};
 // }
 //
 // fn bar(arg: &str, baz: Baz) {
-//     todo!()
+//     ${0:todo!()}
 // }
 //
 // ```
@@ -58,18 +58,27 @@ pub(crate) fn add_function(acc: &mut Assists, ctx: &AssistContext) -> Option<()>
     let function_builder = FunctionBuilder::from_call(&ctx, &call, &path, target_module)?;
 
     let target = call.syntax().text_range();
-    acc.add(AssistId("add_function"), "Add function", target, |edit| {
+    acc.add(AssistId("add_function"), "Add function", target, |builder| {
         let function_template = function_builder.render();
-        edit.set_file(function_template.file);
-        edit.set_cursor(function_template.cursor_offset);
-        edit.insert(function_template.insert_offset, function_template.fn_def.to_string());
+        builder.set_file(function_template.file);
+        match ctx.config.snippet_cap {
+            Some(cap) => {
+                let snippet = render_snippet(
+                    function_template.fn_def.syntax(),
+                    function_template.placeholder_expr.syntax(),
+                );
+                builder.insert_snippet(cap, function_template.insert_offset, snippet)
+            }
+            None => builder
+                .insert(function_template.insert_offset, function_template.fn_def.to_string()),
+        }
     })
 }
 
 struct FunctionTemplate {
     insert_offset: TextSize,
-    cursor_offset: TextSize,
     fn_def: ast::SourceFile,
+    placeholder_expr: ast::MacroCall,
     file: FileId,
 }
 
@@ -136,9 +145,7 @@ impl FunctionBuilder {
 
         let placeholder_expr =
             fn_def.syntax().descendants().find_map(ast::MacroCall::cast).unwrap();
-        let cursor_offset_from_fn_start = placeholder_expr.syntax().text_range().start();
-        let cursor_offset = insert_offset + cursor_offset_from_fn_start;
-        FunctionTemplate { insert_offset, cursor_offset, fn_def, file: self.file }
+        FunctionTemplate { insert_offset, placeholder_expr, fn_def, file: self.file }
     }
 }
 
@@ -316,7 +323,7 @@ fn foo() {
 }
 
 fn bar() {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -343,7 +350,7 @@ impl Foo {
 }
 
 fn bar() {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -367,7 +374,7 @@ fn foo1() {
 }
 
 fn bar() {
-    <|>todo!()
+    ${0:todo!()}
 }
 
 fn foo2() {}
@@ -393,7 +400,7 @@ mod baz {
     }
 
     fn bar() {
-        <|>todo!()
+        ${0:todo!()}
     }
 }
 ",
@@ -419,7 +426,7 @@ fn foo() {
 }
 
 fn bar(baz: Baz) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         );
@@ -452,7 +459,7 @@ impl Baz {
 }
 
 fn bar(baz: Baz) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -473,7 +480,7 @@ fn foo() {
 }
 
 fn bar(arg: &str) {
-    <|>todo!()
+    ${0:todo!()}
 }
 "#,
         )
@@ -494,7 +501,7 @@ fn foo() {
 }
 
 fn bar(arg: char) {
-    <|>todo!()
+    ${0:todo!()}
 }
 "#,
         )
@@ -515,7 +522,7 @@ fn foo() {
 }
 
 fn bar(arg: i32) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -536,7 +543,7 @@ fn foo() {
 }
 
 fn bar(arg: u8) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -561,7 +568,7 @@ fn foo() {
 }
 
 fn bar(x: u8) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -584,7 +591,7 @@ fn foo() {
 }
 
 fn bar(worble: ()) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -613,7 +620,7 @@ fn baz() {
 }
 
 fn bar(foo: impl Foo) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -640,7 +647,7 @@ fn foo() {
 }
 
 fn bar(baz: &Baz) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -669,7 +676,7 @@ fn foo() {
 }
 
 fn bar(baz: Baz::Bof) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -692,7 +699,7 @@ fn foo<T>(t: T) {
 }
 
 fn bar<T>(t: T) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -723,7 +730,7 @@ fn foo() {
 }
 
 fn bar(arg: fn() -> Baz) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -748,7 +755,7 @@ fn foo() {
 }
 
 fn bar(closure: impl Fn(i64) -> i64) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -769,7 +776,7 @@ fn foo() {
 }
 
 fn bar(baz: ()) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -794,7 +801,7 @@ fn foo() {
 }
 
 fn bar(baz_1: Baz, baz_2: Baz) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -819,7 +826,7 @@ fn foo() {
 }
 
 fn bar(baz_1: Baz, baz_2: Baz, arg_1: &str, arg_2: &str) {
-    <|>todo!()
+    ${0:todo!()}
 }
 "#,
         )
@@ -839,7 +846,7 @@ fn foo() {
             r"
 mod bar {
     pub(crate) fn my_fn() {
-        <|>todo!()
+        ${0:todo!()}
     }
 }
 
@@ -878,7 +885,7 @@ fn bar() {
 }
 
 fn baz(foo: foo::Foo) {
-    <|>todo!()
+    ${0:todo!()}
 }
 ",
         )
@@ -902,7 +909,7 @@ mod bar {
     fn something_else() {}
 
     pub(crate) fn my_fn() {
-        <|>todo!()
+        ${0:todo!()}
     }
 }
 
@@ -930,7 +937,7 @@ fn foo() {
 mod bar {
     mod baz {
         pub(crate) fn my_fn() {
-            <|>todo!()
+            ${0:todo!()}
         }
     }
 }
@@ -959,7 +966,7 @@ fn main() {
 
 
 pub(crate) fn bar() {
-    <|>todo!()
+    ${0:todo!()}
 }",
         )
     }
diff --git a/crates/ra_assists/src/tests/generated.rs b/crates/ra_assists/src/tests/generated.rs
@@ -78,7 +78,7 @@ fn foo() {
 }
 
 fn bar(arg: &str, baz: Baz) {
-    todo!()
+    ${0:todo!()}
 }
 
 "#####,
diff --git a/crates/ra_assists/src/utils.rs b/crates/ra_assists/src/utils.rs
@@ -1,18 +1,38 @@
 //! Assorted functions shared by several assists.
 pub(crate) mod insert_use;
 
-use std::iter;
+use std::{iter, ops};
 
 use hir::{Adt, Crate, Semantics, Trait, Type};
 use ra_ide_db::RootDatabase;
 use ra_syntax::{
     ast::{self, make, NameOwner},
-    AstNode, T,
+    AstNode, SyntaxNode, T,
 };
 use rustc_hash::FxHashSet;
 
 pub(crate) use insert_use::insert_use_statement;
 
+pub(crate) fn render_snippet(node: &SyntaxNode, placeholder: &SyntaxNode) -> String {
+    assert!(placeholder.ancestors().any(|it| it == *node));
+    let range = placeholder.text_range() - node.text_range().start();
+    let range: ops::Range<usize> = range.into();
+
+    let mut placeholder = placeholder.to_string();
+    escape(&mut placeholder);
+    let tab_stop = format!("${{0:{}}}", placeholder);
+
+    let mut buf = node.to_string();
+    buf.replace_range(range, &tab_stop);
+    return buf;
+
+    fn escape(buf: &mut String) {
+        stdx::replace(buf, '{', r"\{");
+        stdx::replace(buf, '}', r"\}");
+        stdx::replace(buf, '$', r"\$");
+    }
+}
+
 pub fn get_missing_assoc_items(
     sema: &Semantics<RootDatabase>,
     impl_def: &ast::ImplDef,
diff --git a/crates/stdx/src/lib.rs b/crates/stdx/src/lib.rs
@@ -116,3 +116,11 @@ pub fn to_lower_snake_case(s: &str) -> String {
     }
     buf
 }
+
+pub fn replace(buf: &mut String, from: char, to: &str) {
+    if !buf.contains(from) {
+        return;
+    }
+    // FIXME: do this in place.
+    *buf = buf.replace(from, to)
+}
diff --git a/docs/user/assists.md b/docs/user/assists.md
@@ -77,7 +77,7 @@ fn foo() {
 }
 
 fn bar(arg: &str, baz: Baz) {
-    todo!()
+    ${0:todo!()}
 }
 
 ```

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ use ra_syntax::{`
`10`	`10`	`};`
`11`	`11`	`use rustc_hash::{FxHashMap, FxHashSet};`
`12`	`12`
`13`		`-use crate::{AssistContext, AssistId, Assists};`
	`13`	`+use crate::{utils::render_snippet, AssistContext, AssistId, Assists};`
`14`	`14`
`15`	`15`	`// Assist: add_function`
`16`	`16`	`//`
`@@ -33,7 +33,7 @@ use crate::{AssistContext, AssistId, Assists};`
`33`	`33`	`// }`
`34`	`34`	`//`
`35`	`35`	`// fn bar(arg: &str, baz: Baz) {`
`36`		`-// todo!()`
	`36`	`+// ${0:todo!()}`
`37`	`37`	`// }`
`38`	`38`	`//`
`39`	`39`	// ```
`@@ -58,18 +58,27 @@ pub(crate) fn add_function(acc: &mut Assists, ctx: &AssistContext) -> Option<()>`
`58`	`58`	`let function_builder = FunctionBuilder::from_call(&ctx, &call, &path, target_module)?;`
`59`	`59`
`60`	`60`	`let target = call.syntax().text_range();`
`61`		`- acc.add(AssistId("add_function"), "Add function", target, \|edit\| {`
	`61`	`+ acc.add(AssistId("add_function"), "Add function", target, \|builder\| {`
`62`	`62`	`let function_template = function_builder.render();`
`63`		`- edit.set_file(function_template.file);`
`64`		`- edit.set_cursor(function_template.cursor_offset);`
`65`		`- edit.insert(function_template.insert_offset, function_template.fn_def.to_string());`
	`63`	`+ builder.set_file(function_template.file);`
	`64`	`+ match ctx.config.snippet_cap {`
	`65`	`+ Some(cap) => {`
	`66`	`+ let snippet = render_snippet(`
	`67`	`+ function_template.fn_def.syntax(),`
	`68`	`+ function_template.placeholder_expr.syntax(),`
	`69`	`+ );`
	`70`	`+ builder.insert_snippet(cap, function_template.insert_offset, snippet)`
	`71`	`+ }`
	`72`	`+ None => builder`
	`73`	`+ .insert(function_template.insert_offset, function_template.fn_def.to_string()),`
	`74`	`+ }`
`66`	`75`	`})`
`67`	`76`	`}`
`68`	`77`
`69`	`78`	`struct FunctionTemplate {`
`70`	`79`	`insert_offset: TextSize,`
`71`		`- cursor_offset: TextSize,`
`72`	`80`	`fn_def: ast::SourceFile,`
	`81`	`+ placeholder_expr: ast::MacroCall,`
`73`	`82`	`file: FileId,`
`74`	`83`	`}`
`75`	`84`
`@@ -136,9 +145,7 @@ impl FunctionBuilder {`
`136`	`145`
`137`	`146`	`let placeholder_expr =`
`138`	`147`	`fn_def.syntax().descendants().find_map(ast::MacroCall::cast).unwrap();`
`139`		`- let cursor_offset_from_fn_start = placeholder_expr.syntax().text_range().start();`
`140`		`- let cursor_offset = insert_offset + cursor_offset_from_fn_start;`
`141`		`- FunctionTemplate { insert_offset, cursor_offset, fn_def, file: self.file }`
	`148`	`+ FunctionTemplate { insert_offset, placeholder_expr, fn_def, file: self.file }`
`142`	`149`	`}`
`143`	`150`	`}`
`144`	`151`
`@@ -316,7 +323,7 @@ fn foo() {`
`316`	`323`	`}`
`317`	`324`
`318`	`325`	`fn bar() {`
`319`		`- <\|>todo!()`
	`326`	`+ ${0:todo!()}`
`320`	`327`	`}`
`321`	`328`	`",`
`322`	`329`	`)`
`@@ -343,7 +350,7 @@ impl Foo {`
`343`	`350`	`}`
`344`	`351`
`345`	`352`	`fn bar() {`
`346`		`- <\|>todo!()`
	`353`	`+ ${0:todo!()}`
`347`	`354`	`}`
`348`	`355`	`",`
`349`	`356`	`)`
`@@ -367,7 +374,7 @@ fn foo1() {`
`367`	`374`	`}`
`368`	`375`
`369`	`376`	`fn bar() {`
`370`		`- <\|>todo!()`
	`377`	`+ ${0:todo!()}`
`371`	`378`	`}`
`372`	`379`
`373`	`380`	`fn foo2() {}`
`@@ -393,7 +400,7 @@ mod baz {`
`393`	`400`	`}`
`394`	`401`
`395`	`402`	`fn bar() {`
`396`		`- <\|>todo!()`
	`403`	`+ ${0:todo!()}`
`397`	`404`	`}`
`398`	`405`	`}`
`399`	`406`	`",`
`@@ -419,7 +426,7 @@ fn foo() {`
`419`	`426`	`}`
`420`	`427`
`421`	`428`	`fn bar(baz: Baz) {`
`422`		`- <\|>todo!()`
	`429`	`+ ${0:todo!()}`
`423`	`430`	`}`
`424`	`431`	`",`
`425`	`432`	`);`
`@@ -452,7 +459,7 @@ impl Baz {`
`452`	`459`	`}`
`453`	`460`
`454`	`461`	`fn bar(baz: Baz) {`
`455`		`- <\|>todo!()`
	`462`	`+ ${0:todo!()}`
`456`	`463`	`}`
`457`	`464`	`",`
`458`	`465`	`)`
`@@ -473,7 +480,7 @@ fn foo() {`
`473`	`480`	`}`
`474`	`481`
`475`	`482`	`fn bar(arg: &str) {`
`476`		`- <\|>todo!()`
	`483`	`+ ${0:todo!()}`
`477`	`484`	`}`
`478`	`485`	`"#,`
`479`	`486`	`)`
`@@ -494,7 +501,7 @@ fn foo() {`
`494`	`501`	`}`
`495`	`502`
`496`	`503`	`fn bar(arg: char) {`
`497`		`- <\|>todo!()`
	`504`	`+ ${0:todo!()}`
`498`	`505`	`}`
`499`	`506`	`"#,`
`500`	`507`	`)`
`@@ -515,7 +522,7 @@ fn foo() {`
`515`	`522`	`}`
`516`	`523`
`517`	`524`	`fn bar(arg: i32) {`
`518`		`- <\|>todo!()`
	`525`	`+ ${0:todo!()}`
`519`	`526`	`}`
`520`	`527`	`",`
`521`	`528`	`)`
`@@ -536,7 +543,7 @@ fn foo() {`
`536`	`543`	`}`
`537`	`544`
`538`	`545`	`fn bar(arg: u8) {`
`539`		`- <\|>todo!()`
	`546`	`+ ${0:todo!()}`
`540`	`547`	`}`
`541`	`548`	`",`
`542`	`549`	`)`
`@@ -561,7 +568,7 @@ fn foo() {`
`561`	`568`	`}`
`562`	`569`
`563`	`570`	`fn bar(x: u8) {`
`564`		`- <\|>todo!()`
	`571`	`+ ${0:todo!()}`
`565`	`572`	`}`
`566`	`573`	`",`
`567`	`574`	`)`
`@@ -584,7 +591,7 @@ fn foo() {`
`584`	`591`	`}`
`585`	`592`
`586`	`593`	`fn bar(worble: ()) {`
`587`		`- <\|>todo!()`
	`594`	`+ ${0:todo!()}`
`588`	`595`	`}`
`589`	`596`	`",`
`590`	`597`	`)`
`@@ -613,7 +620,7 @@ fn baz() {`
`613`	`620`	`}`
`614`	`621`
`615`	`622`	`fn bar(foo: impl Foo) {`
`616`		`- <\|>todo!()`
	`623`	`+ ${0:todo!()}`
`617`	`624`	`}`
`618`	`625`	`",`
`619`	`626`	`)`
`@@ -640,7 +647,7 @@ fn foo() {`
`640`	`647`	`}`
`641`	`648`
`642`	`649`	`fn bar(baz: &Baz) {`
`643`		`- <\|>todo!()`
	`650`	`+ ${0:todo!()}`
`644`	`651`	`}`
`645`	`652`	`",`
`646`	`653`	`)`
`@@ -669,7 +676,7 @@ fn foo() {`
`669`	`676`	`}`
`670`	`677`
`671`	`678`	`fn bar(baz: Baz::Bof) {`
`672`		`- <\|>todo!()`
	`679`	`+ ${0:todo!()}`
`673`	`680`	`}`
`674`	`681`	`",`
`675`	`682`	`)`
`@@ -692,7 +699,7 @@ fn foo<T>(t: T) {`
`692`	`699`	`}`
`693`	`700`
`694`	`701`	`fn bar<T>(t: T) {`
`695`		`- <\|>todo!()`
	`702`	`+ ${0:todo!()}`
`696`	`703`	`}`
`697`	`704`	`",`
`698`	`705`	`)`
`@@ -723,7 +730,7 @@ fn foo() {`
`723`	`730`	`}`
`724`	`731`
`725`	`732`	`fn bar(arg: fn() -> Baz) {`
`726`		`- <\|>todo!()`
	`733`	`+ ${0:todo!()}`
`727`	`734`	`}`
`728`	`735`	`",`
`729`	`736`	`)`
`@@ -748,7 +755,7 @@ fn foo() {`
`748`	`755`	`}`
`749`	`756`
`750`	`757`	`fn bar(closure: impl Fn(i64) -> i64) {`
`751`		`- <\|>todo!()`
	`758`	`+ ${0:todo!()}`
`752`	`759`	`}`
`753`	`760`	`",`
`754`	`761`	`)`
`@@ -769,7 +776,7 @@ fn foo() {`
`769`	`776`	`}`
`770`	`777`
`771`	`778`	`fn bar(baz: ()) {`
`772`		`- <\|>todo!()`
	`779`	`+ ${0:todo!()}`
`773`	`780`	`}`
`774`	`781`	`",`
`775`	`782`	`)`
`@@ -794,7 +801,7 @@ fn foo() {`
`794`	`801`	`}`
`795`	`802`
`796`	`803`	`fn bar(baz_1: Baz, baz_2: Baz) {`
`797`		`- <\|>todo!()`
	`804`	`+ ${0:todo!()}`
`798`	`805`	`}`
`799`	`806`	`",`
`800`	`807`	`)`
`@@ -819,7 +826,7 @@ fn foo() {`
`819`	`826`	`}`
`820`	`827`
`821`	`828`	`fn bar(baz_1: Baz, baz_2: Baz, arg_1: &str, arg_2: &str) {`
`822`		`- <\|>todo!()`
	`829`	`+ ${0:todo!()}`
`823`	`830`	`}`
`824`	`831`	`"#,`
`825`	`832`	`)`
`@@ -839,7 +846,7 @@ fn foo() {`
`839`	`846`	`r"`
`840`	`847`	`mod bar {`
`841`	`848`	`pub(crate) fn my_fn() {`
`842`		`- <\|>todo!()`
	`849`	`+ ${0:todo!()}`
`843`	`850`	`}`
`844`	`851`	`}`
`845`	`852`
`@@ -878,7 +885,7 @@ fn bar() {`
`878`	`885`	`}`
`879`	`886`
`880`	`887`	`fn baz(foo: foo::Foo) {`
`881`		`- <\|>todo!()`
	`888`	`+ ${0:todo!()}`
`882`	`889`	`}`
`883`	`890`	`",`
`884`	`891`	`)`
`@@ -902,7 +909,7 @@ mod bar {`
`902`	`909`	`fn something_else() {}`
`903`	`910`
`904`	`911`	`pub(crate) fn my_fn() {`
`905`		`- <\|>todo!()`
	`912`	`+ ${0:todo!()}`
`906`	`913`	`}`
`907`	`914`	`}`
`908`	`915`
`@@ -930,7 +937,7 @@ fn foo() {`
`930`	`937`	`mod bar {`
`931`	`938`	`mod baz {`
`932`	`939`	`pub(crate) fn my_fn() {`
`933`		`- <\|>todo!()`
	`940`	`+ ${0:todo!()}`
`934`	`941`	`}`
`935`	`942`	`}`
`936`	`943`	`}`
`@@ -959,7 +966,7 @@ fn main() {`
`959`	`966`
`960`	`967`
`961`	`968`	`pub(crate) fn bar() {`
`962`		`- <\|>todo!()`
	`969`	`+ ${0:todo!()}`
`963`	`970`	`}",`
`964`	`971`	`)`
`965`	`972`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ fn foo() {`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`fn bar(arg: &str, baz: Baz) {`
`81`		`- todo!()`
	`81`	`+ ${0:todo!()}`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`"#####,`
Original file line number	Diff line number	Diff line change
`@@ -116,3 +116,11 @@ pub fn to_lower_snake_case(s: &str) -> String {`
`116`	`116`	`}`
`117`	`117`	`buf`
`118`	`118`	`}`
	`119`	`+`
	`120`	`+pub fn replace(buf: &mut String, from: char, to: &str) {`
	`121`	`+ if !buf.contains(from) {`
	`122`	`+ return;`
	`123`	`+ }`
	`124`	`+ // FIXME: do this in place.`
	`125`	`+ *buf = buf.replace(from, to)`
	`126`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ fn foo() {`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`fn bar(arg: &str, baz: Baz) {`
`80`		`- todo!()`
	`80`	`+ ${0:todo!()}`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	```