diff --git a/crates/ide/src/children_modules.rs b/crates/ide/src/children_modules.rs new file mode 100644 index 000000000000..4bb7cb8424cc --- /dev/null +++ b/crates/ide/src/children_modules.rs @@ -0,0 +1,123 @@ +use hir::Semantics; +use ide_db::{FilePosition, RootDatabase}; +use syntax::{ + algo::find_node_at_offset, + ast::{self, AstNode}, +}; + +use crate::NavigationTarget; + +// Feature: Children Modules +// +// Navigates to the children modules of the current module. +// +// | Editor | Action Name | +// |---------|-------------| +// | VS Code | **rust-analyzer: Locate children modules** | + +/// This returns `Vec` because a module may be included from several places. +pub(crate) fn children_modules(db: &RootDatabase, position: FilePosition) -> Vec { + let sema = Semantics::new(db); + let source_file = sema.parse_guess_edition(position.file_id); + // First go to the parent module which contains the cursor + let module = find_node_at_offset::(source_file.syntax(), position.offset); + + match module { + Some(module) => { + // Return all the children module inside the ItemList of the parent module + sema.to_def(&module) + .into_iter() + .flat_map(|module| module.children(db)) + .map(|module| NavigationTarget::from_module_to_decl(db, module).call_site()) + .collect() + } + None => { + // Return all the children module inside the source file + sema.file_to_module_defs(position.file_id) + .flat_map(|module| module.children(db)) + .map(|module| NavigationTarget::from_module_to_decl(db, module).call_site()) + .collect() + } + } +} + +#[cfg(test)] +mod tests { + use ide_db::FileRange; + + use crate::fixture; + + fn check_children_module(#[rust_analyzer::rust_fixture] ra_fixture: &str) { + let (analysis, position, expected) = fixture::annotations(ra_fixture); + let navs = analysis.children_modules(position).unwrap(); + let navs = navs + .iter() + .map(|nav| FileRange { file_id: nav.file_id, range: nav.focus_or_full_range() }) + .collect::>(); + assert_eq!(expected.into_iter().map(|(fr, _)| fr).collect::>(), navs); + } + + #[test] + fn test_resolve_children_module() { + check_children_module( + r#" +//- /lib.rs +$0 +mod foo; + //^^^ + +//- /foo.rs +// empty +"#, + ); + } + + #[test] + fn test_resolve_children_module_on_module_decl() { + check_children_module( + r#" +//- /lib.rs +mod $0foo; +//- /foo.rs +mod bar; + //^^^ + +//- /foo/bar.rs +// empty +"#, + ); + } + + #[test] + fn test_resolve_children_module_for_inline() { + check_children_module( + r#" +//- /lib.rs +mod foo { + mod $0bar { + mod baz {} + } //^^^ +} +"#, + ); + } + + #[test] + fn test_resolve_multi_child_module() { + check_children_module( + r#" +//- /main.rs +$0 +mod foo; + //^^^ +mod bar; + //^^^ +//- /foo.rs +// empty + +//- /bar.rs +// empty +"#, + ); + } +} diff --git a/crates/ide/src/lib.rs b/crates/ide/src/lib.rs index 13b161e59d94..a517dd0381d2 100644 --- a/crates/ide/src/lib.rs +++ b/crates/ide/src/lib.rs @@ -20,6 +20,7 @@ mod navigation_target; mod annotations; mod call_hierarchy; +mod children_modules; mod doc_links; mod expand_macro; mod extend_selection; @@ -605,6 +606,11 @@ impl Analysis { self.with_db(|db| parent_module::parent_module(db, position)) } + /// Returns vec of `mod name;` declaration which are created by the current module. + pub fn children_modules(&self, position: FilePosition) -> Cancellable> { + self.with_db(|db| children_modules::children_modules(db, position)) + } + /// Returns crates that this file belongs to. pub fn crates_for(&self, file_id: FileId) -> Cancellable> { self.with_db(|db| parent_module::crates_for(db, file_id)) diff --git a/crates/rust-analyzer/src/handlers/request.rs b/crates/rust-analyzer/src/handlers/request.rs index 75fe99e95d91..0444a0ebf6a6 100644 --- a/crates/rust-analyzer/src/handlers/request.rs +++ b/crates/rust-analyzer/src/handlers/request.rs @@ -943,6 +943,18 @@ pub(crate) fn handle_parent_module( Ok(Some(res)) } +pub(crate) fn handle_children_modules( + snap: GlobalStateSnapshot, + params: lsp_types::TextDocumentPositionParams, +) -> anyhow::Result> { + let _p = tracing::info_span!("handle_children_module").entered(); + // locate children module by semantics + let position = try_default!(from_proto::file_position(&snap, params)?); + let navs = snap.analysis.children_modules(position)?; + let res = to_proto::goto_definition_response(&snap, None, navs)?; + Ok(Some(res)) +} + pub(crate) fn handle_runnables( snap: GlobalStateSnapshot, params: lsp_ext::RunnablesParams, diff --git a/crates/rust-analyzer/src/lsp/capabilities.rs b/crates/rust-analyzer/src/lsp/capabilities.rs index 7fa8e488b5c8..e751e7da70e1 100644 --- a/crates/rust-analyzer/src/lsp/capabilities.rs +++ b/crates/rust-analyzer/src/lsp/capabilities.rs @@ -157,6 +157,7 @@ pub fn server_capabilities(config: &Config) -> ServerCapabilities { "onEnter": true, "openCargoToml": true, "parentModule": true, + "childrenModules": true, "runnables": { "kinds": [ "cargo" ], }, diff --git a/crates/rust-analyzer/src/lsp/ext.rs b/crates/rust-analyzer/src/lsp/ext.rs index 876a0db8e111..ae4a9dbe19e0 100644 --- a/crates/rust-analyzer/src/lsp/ext.rs +++ b/crates/rust-analyzer/src/lsp/ext.rs @@ -399,6 +399,14 @@ impl Request for ParentModule { const METHOD: &'static str = "experimental/parentModule"; } +pub enum ChildrenModules {} + +impl Request for ChildrenModules { + type Params = lsp_types::TextDocumentPositionParams; + type Result = Option; + const METHOD: &'static str = "experimental/childrenModule"; +} + pub enum JoinLines {} impl Request for JoinLines { diff --git a/crates/rust-analyzer/src/main_loop.rs b/crates/rust-analyzer/src/main_loop.rs index 47fcb5ac02b7..0b5d040df20b 100644 --- a/crates/rust-analyzer/src/main_loop.rs +++ b/crates/rust-analyzer/src/main_loop.rs @@ -1172,6 +1172,7 @@ impl GlobalState { .on::(handlers::handle_interpret_function) .on::(handlers::handle_expand_macro) .on::(handlers::handle_parent_module) + .on::(handlers::handle_children_modules) .on::(handlers::handle_runnables) .on::(handlers::handle_related_tests) .on::(handlers::handle_code_action) diff --git a/docs/book/src/contributing/lsp-extensions.md b/docs/book/src/contributing/lsp-extensions.md index 16217a7aa9ef..8854f580ea06 100644 --- a/docs/book/src/contributing/lsp-extensions.md +++ b/docs/book/src/contributing/lsp-extensions.md @@ -1,5 +1,5 @@