rust/crates/ra_assists/src/assists/change_visibility.rs

160 lines
5.0 KiB
Rust
Raw Normal View History

2019-02-03 12:26:35 -06:00
use hir::db::HirDatabase;
2019-01-03 06:08:32 -06:00
use ra_syntax::{
ast::{self, NameOwner, VisibilityOwner},
AstNode,
SyntaxKind::{
ATTR, COMMENT, ENUM_DEF, FN_DEF, IDENT, MODULE, STRUCT_DEF, TRAIT_DEF, VISIBILITY,
WHITESPACE,
},
SyntaxNode, TextUnit, T,
2019-01-03 06:08:32 -06:00
};
use crate::{Assist, AssistCtx, AssistId};
2019-01-03 06:08:32 -06:00
2019-02-03 12:26:35 -06:00
pub(crate) fn change_visibility(ctx: AssistCtx<impl HirDatabase>) -> Option<Assist> {
if let Some(vis) = ctx.node_at_offset::<ast::Visibility>() {
return change_vis(ctx, vis);
}
add_vis(ctx)
}
fn add_vis(mut ctx: AssistCtx<impl HirDatabase>) -> Option<Assist> {
2019-03-30 05:25:53 -05:00
let item_keyword = ctx.token_at_offset().find(|leaf| match leaf.kind() {
2019-05-15 07:35:47 -05:00
T![fn] | T![mod] | T![struct] | T![enum] | T![trait] => true,
2019-01-03 06:08:32 -06:00
_ => false,
});
2019-02-08 15:43:13 -06:00
let (offset, target) = if let Some(keyword) = item_keyword {
2019-03-30 05:25:53 -05:00
let parent = keyword.parent();
2019-01-03 10:37:41 -06:00
let def_kws = vec![FN_DEF, MODULE, STRUCT_DEF, ENUM_DEF, TRAIT_DEF];
// Parent is not a definition, can't add visibility
if !def_kws.iter().any(|&def_kw| def_kw == parent.kind()) {
return None;
}
// Already have visibility, do nothing
if parent.children().any(|child| child.kind() == VISIBILITY) {
return None;
}
2019-07-20 04:58:27 -05:00
(vis_offset(&parent), keyword.text_range())
2019-01-03 10:37:41 -06:00
} else {
2019-03-30 05:25:53 -05:00
let ident = ctx.token_at_offset().find(|leaf| leaf.kind() == IDENT)?;
2019-08-23 07:55:21 -05:00
let field = ident.parent().ancestors().find_map(ast::RecordFieldDef::cast)?;
2019-07-20 04:58:27 -05:00
if field.name()?.syntax().text_range() != ident.text_range() && field.visibility().is_some()
{
2019-01-03 10:37:41 -06:00
return None;
}
2019-07-20 04:58:27 -05:00
(vis_offset(field.syntax()), ident.text_range())
2019-01-03 10:37:41 -06:00
};
2019-01-03 06:08:32 -06:00
2019-02-24 04:53:35 -06:00
ctx.add_action(AssistId("change_visibility"), "make pub(crate)", |edit| {
2019-02-08 15:43:13 -06:00
edit.target(target);
2019-01-03 10:37:41 -06:00
edit.insert(offset, "pub(crate) ");
edit.set_cursor(offset);
});
ctx.build()
2019-01-03 06:08:32 -06:00
}
fn vis_offset(node: &SyntaxNode) -> TextUnit {
2019-03-30 05:25:53 -05:00
node.children_with_tokens()
.skip_while(|it| match it.kind() {
WHITESPACE | COMMENT | ATTR => true,
_ => false,
})
.next()
2019-07-20 04:58:27 -05:00
.map(|it| it.text_range().start())
.unwrap_or_else(|| node.text_range().start())
}
2019-07-19 03:24:41 -05:00
fn change_vis(mut ctx: AssistCtx<impl HirDatabase>, vis: ast::Visibility) -> Option<Assist> {
if vis.syntax().text() == "pub" {
2019-02-24 04:53:35 -06:00
ctx.add_action(AssistId("change_visibility"), "change to pub(crate)", |edit| {
2019-07-20 04:58:27 -05:00
edit.target(vis.syntax().text_range());
edit.replace(vis.syntax().text_range(), "pub(crate)");
edit.set_cursor(vis.syntax().text_range().start())
});
return ctx.build();
}
if vis.syntax().text() == "pub(crate)" {
2019-02-24 04:53:35 -06:00
ctx.add_action(AssistId("change_visibility"), "change to pub", |edit| {
2019-07-20 04:58:27 -05:00
edit.target(vis.syntax().text_range());
edit.replace(vis.syntax().text_range(), "pub");
edit.set_cursor(vis.syntax().text_range().start());
});
return ctx.build();
}
None
}
2019-01-03 06:08:32 -06:00
#[cfg(test)]
mod tests {
use super::*;
2019-02-08 17:34:05 -06:00
use crate::helpers::{check_assist, check_assist_target};
2019-01-03 06:08:32 -06:00
#[test]
2019-01-03 10:37:41 -06:00
fn change_visibility_adds_pub_crate_to_items() {
2019-02-08 05:49:43 -06:00
check_assist(change_visibility, "<|>fn foo() {}", "<|>pub(crate) fn foo() {}");
check_assist(change_visibility, "f<|>n foo() {}", "<|>pub(crate) fn foo() {}");
check_assist(change_visibility, "<|>struct Foo {}", "<|>pub(crate) struct Foo {}");
check_assist(change_visibility, "<|>mod foo {}", "<|>pub(crate) mod foo {}");
check_assist(change_visibility, "<|>trait Foo {}", "<|>pub(crate) trait Foo {}");
2019-01-03 09:59:17 -06:00
check_assist(change_visibility, "m<|>od {}", "<|>pub(crate) mod {}");
check_assist(
change_visibility,
2019-01-03 06:08:32 -06:00
"unsafe f<|>n foo() {}",
"<|>pub(crate) unsafe fn foo() {}",
);
}
2019-01-03 10:37:41 -06:00
#[test]
fn change_visibility_works_with_struct_fields() {
check_assist(
change_visibility,
"struct S { <|>field: u32 }",
"struct S { <|>pub(crate) field: u32 }",
)
}
#[test]
fn change_visibility_pub_to_pub_crate() {
2019-02-08 05:49:43 -06:00
check_assist(change_visibility, "<|>pub fn foo() {}", "<|>pub(crate) fn foo() {}")
}
#[test]
fn change_visibility_pub_crate_to_pub() {
2019-02-08 05:49:43 -06:00
check_assist(change_visibility, "<|>pub(crate) fn foo() {}", "<|>pub fn foo() {}")
}
#[test]
fn change_visibility_handles_comment_attrs() {
check_assist(
change_visibility,
"
/// docs
// comments
#[derive(Debug)]
<|>struct Foo;
",
"
/// docs
// comments
#[derive(Debug)]
<|>pub(crate) struct Foo;
",
)
}
2019-02-08 17:34:05 -06:00
#[test]
fn change_visibility_target() {
check_assist_target(change_visibility, "<|>fn foo() {}", "fn");
check_assist_target(change_visibility, "pub(crate)<|> fn foo() {}", "pub(crate)");
check_assist_target(change_visibility, "struct S { <|>field: u32 }", "field");
}
2019-01-03 06:08:32 -06:00
}