use ide_db::source_change::SourceChangeBuilder; use syntax::{ AstToken, ast::{self, IsString, make::tokens::literal}, }; use crate::{ AssistContext, AssistId, Assists, utils::{required_hashes, string_prefix, string_suffix}, }; // Assist: make_raw_string // // Adds `r#` to a plain string literal. // // ``` // fn main() { // "Hello,$0 World!"; // } // ``` // -> // ``` // fn main() { // r#"Hello, World!"#; // } // ``` pub(crate) fn make_raw_string(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> { let token = ctx.find_token_at_offset::()?; if token.is_raw() { return None; } let value = token.value().ok()?; let target = token.syntax().text_range(); acc.add( AssistId::refactor_rewrite("make_raw_string"), "Rewrite as raw string", target, |edit| { let hashes = "#".repeat(required_hashes(&value).max(1)); let raw_prefix = token.raw_prefix(); let suffix = string_suffix(token.text()).unwrap_or_default(); let new_str = format!("{raw_prefix}{hashes}\"{value}\"{hashes}{suffix}"); replace_literal(&token, &new_str, edit, ctx); }, ) } // Assist: make_usual_string // // Turns a raw string into a plain string. // // ``` // fn main() { // r#"Hello,$0 "World!""#; // } // ``` // -> // ``` // fn main() { // "Hello, \"World!\""; // } // ``` pub(crate) fn make_usual_string(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> { let token = ctx.find_token_at_offset::()?; if !token.is_raw() { return None; } let value = token.value().ok()?; let target = token.syntax().text_range(); acc.add( AssistId::refactor_rewrite("make_usual_string"), "Rewrite as regular string", target, |edit| { // parse inside string to escape `"` let escaped = value.escape_default().to_string(); let suffix = string_suffix(token.text()).unwrap_or_default(); let prefix = string_prefix(token.text()).map_or("", |s| s.trim_end_matches('r')); let new_str = format!("{prefix}\"{escaped}\"{suffix}"); replace_literal(&token, &new_str, edit, ctx); }, ) } // Assist: add_hash // // Adds a hash to a raw string literal. // // ``` // fn main() { // r#"Hello,$0 World!"#; // } // ``` // -> // ``` // fn main() { // r##"Hello, World!"##; // } // ``` pub(crate) fn add_hash(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> { let token = ctx.find_token_at_offset::()?; if !token.is_raw() { return None; } let target = token.syntax().text_range(); acc.add(AssistId::refactor("add_hash"), "Add #", target, |edit| { let str = token.text(); let suffix = string_suffix(str).unwrap_or_default(); let raw_prefix = token.raw_prefix(); let wrap_range = raw_prefix.len()..str.len() - suffix.len(); let new_str = [raw_prefix, "#", &str[wrap_range], "#", suffix].concat(); replace_literal(&token, &new_str, edit, ctx); }) } // Assist: remove_hash // // Removes a hash from a raw string literal. // // ``` // fn main() { // r#"Hello,$0 World!"#; // } // ``` // -> // ``` // fn main() { // r"Hello, World!"; // } // ``` pub(crate) fn remove_hash(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> { let token = ctx.find_token_at_offset::()?; if !token.is_raw() { return None; } let text = token.text(); let existing_hashes = text.chars().skip(token.raw_prefix().len()).take_while(|&it| it == '#').count(); let text_range = token.syntax().text_range(); let internal_text = &text[token.text_range_between_quotes()? - text_range.start()]; if existing_hashes == required_hashes(internal_text) { cov_mark::hit!(cant_remove_required_hash); return None; } acc.add(AssistId::refactor_rewrite("remove_hash"), "Remove #", text_range, |edit| { let suffix = string_suffix(text).unwrap_or_default(); let prefix = token.raw_prefix(); let wrap_range = prefix.len() + 1..text.len() - suffix.len() - 1; let new_str = [prefix, &text[wrap_range], suffix].concat(); replace_literal(&token, &new_str, edit, ctx); }) } fn replace_literal( token: &impl AstToken, new: &str, builder: &mut SourceChangeBuilder, ctx: &AssistContext<'_>, ) { let token = token.syntax(); let node = token.parent().expect("no parent token"); let mut edit = builder.make_editor(&node); let new_literal = literal(new); edit.replace(token, mut_token(new_literal)); builder.add_file_edits(ctx.vfs_file_id(), edit); } fn mut_token(token: syntax::SyntaxToken) -> syntax::SyntaxToken { let node = token.parent().expect("no parent token"); node.clone_for_update() .children_with_tokens() .filter_map(|it| it.into_token()) .find(|it| it.text_range() == token.text_range() && it.text() == token.text()) .unwrap() } #[cfg(test)] mod tests { use super::*; use crate::tests::{check_assist, check_assist_not_applicable, check_assist_target}; #[test] fn make_raw_string_target() { check_assist_target( make_raw_string, r#" fn f() { let s = $0"random\nstring"; } "#, r#""random\nstring""#, ); } #[test] fn make_raw_string_works() { check_assist( make_raw_string, r#" fn f() { let s = $0"random\nstring"; } "#, r##" fn f() { let s = r#"random string"#; } "##, ) } #[test] fn make_raw_string_works_inside_macros() { check_assist( make_raw_string, r#" fn f() { format!($0"x = {}", 92) } "#, r##" fn f() { format!(r#"x = {}"#, 92) } "##, ) } #[test] fn make_raw_byte_string_works() { check_assist( make_raw_string, r#" fn f() { let s = $0b"random\nstring"; } "#, r##" fn f() { let s = br#"random string"#; } "##, ) } #[test] fn make_raw_c_string_works() { check_assist( make_raw_string, r#" fn f() { let s = $0c"random\nstring"; } "#, r##" fn f() { let s = cr#"random string"#; } "##, ) } #[test] fn make_raw_string_hashes_inside_works() { check_assist( make_raw_string, r###" fn f() { let s = $0"#random##\nstring"; } "###, r####" fn f() { let s = r#"#random## string"#; } "####, ) } #[test] fn make_raw_string_closing_hashes_inside_works() { check_assist( make_raw_string, r###" fn f() { let s = $0"#random\"##\nstring"; } "###, r####" fn f() { let s = r###"#random"## string"###; } "####, ) } #[test] fn make_raw_string_nothing_to_unescape_works() { check_assist( make_raw_string, r#" fn f() { let s = $0"random string"; } "#, r##" fn f() { let s = r#"random string"#; } "##, ) } #[test] fn make_raw_string_has_suffix() { check_assist( make_raw_string, r#" fn f() { let s = $0"random string"i32; } "#, r##" fn f() { let s = r#"random string"#i32; } "##, ) } #[test] fn make_raw_string_not_works_on_partial_string() { check_assist_not_applicable( make_raw_string, r#" fn f() { let s = "foo$0 } "#, ) } #[test] fn make_usual_string_not_works_on_partial_string() { check_assist_not_applicable( make_usual_string, r#" fn main() { let s = r#"bar$0 } "#, ) } #[test] fn add_hash_target() { check_assist_target( add_hash, r#" fn f() { let s = $0r"random string"; } "#, r#"r"random string""#, ); } #[test] fn add_hash_works() { check_assist( add_hash, r#" fn f() { let s = $0r"random string"; } "#, r##" fn f() { let s = r#"random string"#; } "##, ) } #[test] fn add_hash_works_for_c_str() { check_assist( add_hash, r#" fn f() { let s = $0cr"random string"; } "#, r##" fn f() { let s = cr#"random string"#; } "##, ) } #[test] fn add_hash_has_suffix_works() { check_assist( add_hash, r#" fn f() { let s = $0r"random string"i32; } "#, r##" fn f() { let s = r#"random string"#i32; } "##, ) } #[test] fn add_more_hash_works() { check_assist( add_hash, r##" fn f() { let s = $0r#"random"string"#; } "##, r###" fn f() { let s = r##"random"string"##; } "###, ) } #[test] fn add_more_hash_has_suffix_works() { check_assist( add_hash, r##" fn f() { let s = $0r#"random"string"#i32; } "##, r###" fn f() { let s = r##"random"string"##i32; } "###, ) } #[test] fn add_hash_not_works() { check_assist_not_applicable( add_hash, r#" fn f() { let s = $0"random string"; } "#, ); } #[test] fn remove_hash_target() { check_assist_target( remove_hash, r##" fn f() { let s = $0r#"random string"#; } "##, r##"r#"random string"#"##, ); } #[test] fn remove_hash_works() { check_assist( remove_hash, r##"fn f() { let s = $0r#"random string"#; }"##, r#"fn f() { let s = r"random string"; }"#, ) } #[test] fn remove_hash_works_for_c_str() { check_assist( remove_hash, r##"fn f() { let s = $0cr#"random string"#; }"##, r#"fn f() { let s = cr"random string"; }"#, ) } #[test] fn remove_hash_has_suffix_works() { check_assist( remove_hash, r##"fn f() { let s = $0r#"random string"#i32; }"##, r#"fn f() { let s = r"random string"i32; }"#, ) } #[test] fn cant_remove_required_hash() { cov_mark::check!(cant_remove_required_hash); check_assist_not_applicable( remove_hash, r##" fn f() { let s = $0r#"random"str"ing"#; } "##, ) } #[test] fn remove_more_hash_works() { check_assist( remove_hash, r###" fn f() { let s = $0r##"random string"##; } "###, r##" fn f() { let s = r#"random string"#; } "##, ) } #[test] fn remove_more_hash_has_suffix_works() { check_assist( remove_hash, r###" fn f() { let s = $0r##"random string"##i32; } "###, r##" fn f() { let s = r#"random string"#i32; } "##, ) } #[test] fn remove_hash_does_not_work() { check_assist_not_applicable(remove_hash, r#"fn f() { let s = $0"random string"; }"#); } #[test] fn remove_hash_no_hash_does_not_work() { check_assist_not_applicable(remove_hash, r#"fn f() { let s = $0r"random string"; }"#); } #[test] fn make_usual_string_target() { check_assist_target( make_usual_string, r##" fn f() { let s = $0r#"random string"#; } "##, r##"r#"random string"#"##, ); } #[test] fn make_usual_string_works() { check_assist( make_usual_string, r##" fn f() { let s = $0r#"random string"#; } "##, r#" fn f() { let s = "random string"; } "#, ) } #[test] fn make_usual_string_for_c_str() { check_assist( make_usual_string, r##" fn f() { let s = $0cr#"random string"#; } "##, r#" fn f() { let s = c"random string"; } "#, ) } #[test] fn make_usual_string_has_suffix_works() { check_assist( make_usual_string, r##" fn f() { let s = $0r#"random string"#i32; } "##, r#" fn f() { let s = "random string"i32; } "#, ) } #[test] fn make_usual_string_with_quote_works() { check_assist( make_usual_string, r##" fn f() { let s = $0r#"random"str"ing"#; } "##, r#" fn f() { let s = "random\"str\"ing"; } "#, ) } #[test] fn make_usual_string_more_hash_works() { check_assist( make_usual_string, r###" fn f() { let s = $0r##"random string"##; } "###, r##" fn f() { let s = "random string"; } "##, ) } #[test] fn make_usual_string_more_hash_has_suffix_works() { check_assist( make_usual_string, r###" fn f() { let s = $0r##"random string"##i32; } "###, r##" fn f() { let s = "random string"i32; } "##, ) } #[test] fn make_usual_string_not_works() { check_assist_not_applicable( make_usual_string, r#" fn f() { let s = $0"random string"; } "#, ); } }