From a85a2c4d151d9d2e8fb016d76aad99a6ca88bc75 Mon Sep 17 00:00:00 2001 From: Jonas Schievink Date: Tue, 11 May 2021 16:15:31 +0200 Subject: [PATCH 1/6] Allow viewing the crate graph in a webview --- Cargo.lock | 7 +++ crates/ide/Cargo.toml | 1 + crates/ide/src/lib.rs | 5 ++ crates/ide/src/view_crate_graph.rs | 81 +++++++++++++++++++++++++++ crates/rust-analyzer/src/handlers.rs | 6 ++ crates/rust-analyzer/src/lsp_ext.rs | 8 +++ crates/rust-analyzer/src/main_loop.rs | 1 + editors/code/package.json | 5 ++ editors/code/src/commands.ts | 8 +++ editors/code/src/lsp_ext.ts | 2 + editors/code/src/main.ts | 1 + 11 files changed, 125 insertions(+) create mode 100644 crates/ide/src/view_crate_graph.rs diff --git a/Cargo.lock b/Cargo.lock index 0e1234b721c3..f9c34547ed54 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -319,6 +319,12 @@ version = "1.0.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "fc4b29f4b9bb94bf267d57269fd0706d343a160937108e9619fe380645428abb" +[[package]] +name = "dot" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a74b6c4d4a1cff5f454164363c16b72fa12463ca6b31f4b5f2035a65fa3d5906" + [[package]] name = "drop_bomb" version = "0.1.5" @@ -588,6 +594,7 @@ version = "0.0.0" dependencies = [ "cfg", "cov-mark", + "dot", "either", "expect-test", "hir", diff --git a/crates/ide/Cargo.toml b/crates/ide/Cargo.toml index f04bcf5316bd..88f3d09d3407 100644 --- a/crates/ide/Cargo.toml +++ b/crates/ide/Cargo.toml @@ -20,6 +20,7 @@ oorandom = "11.1.2" pulldown-cmark-to-cmark = "6.0.0" pulldown-cmark = { version = "0.8.0", default-features = false } url = "2.1.1" +dot = "0.1.4" stdx = { path = "../stdx", version = "0.0.0" } syntax = { path = "../syntax", version = "0.0.0" } diff --git a/crates/ide/src/lib.rs b/crates/ide/src/lib.rs index 8e5b72044968..34360501af8e 100644 --- a/crates/ide/src/lib.rs +++ b/crates/ide/src/lib.rs @@ -49,6 +49,7 @@ mod syntax_tree; mod typing; mod markdown_remove; mod doc_links; +mod view_crate_graph; use std::sync::Arc; @@ -287,6 +288,10 @@ impl Analysis { self.with_db(|db| view_hir::view_hir(&db, position)) } + pub fn view_crate_graph(&self) -> Cancelable> { + self.with_db(|db| view_crate_graph::view_crate_graph(&db)) + } + pub fn expand_macro(&self, position: FilePosition) -> Cancelable> { self.with_db(|db| expand_macro::expand_macro(db, position)) } diff --git a/crates/ide/src/view_crate_graph.rs b/crates/ide/src/view_crate_graph.rs new file mode 100644 index 000000000000..4da4ce2b379f --- /dev/null +++ b/crates/ide/src/view_crate_graph.rs @@ -0,0 +1,81 @@ +use std::{ + error::Error, + io::{Read, Write}, + process::{Command, Stdio}, + sync::Arc, +}; + +use dot::Id; +use ide_db::{ + base_db::{CrateGraph, CrateId, Dependency, SourceDatabase}, + RootDatabase, +}; + +// Feature: View Crate Graph +// +// Renders the currently loaded crate graph as an SVG graphic. Requires the `dot` tool to be +// installed. +// +// |=== +// | Editor | Action Name +// +// | VS Code | **Rust Analyzer: View Crate Graph** +// |=== +pub(crate) fn view_crate_graph(db: &RootDatabase) -> Result { + let mut dot = Vec::new(); + let graph = DotCrateGraph(db.crate_graph()); + dot::render(&graph, &mut dot).unwrap(); + + render_svg(&dot).map_err(|e| e.to_string()) +} + +fn render_svg(dot: &[u8]) -> Result> { + // We shell out to `dot` to render to SVG, as there does not seem to be a pure-Rust renderer. + let child = Command::new("dot") + .arg("-Tsvg") + .stdin(Stdio::piped()) + .stdout(Stdio::piped()) + .spawn() + .map_err(|err| format!("failed to spawn `dot -Tsvg`: {}", err))?; + child.stdin.unwrap().write_all(&dot)?; + + let mut svg = String::new(); + child.stdout.unwrap().read_to_string(&mut svg)?; + Ok(svg) +} + +struct DotCrateGraph(Arc); + +type Edge<'a> = (CrateId, &'a Dependency); + +impl<'a> dot::GraphWalk<'a, CrateId, Edge<'a>> for DotCrateGraph { + fn nodes(&'a self) -> dot::Nodes<'a, CrateId> { + self.0.iter().collect() + } + + fn edges(&'a self) -> dot::Edges<'a, Edge<'a>> { + self.0 + .iter() + .flat_map(|krate| self.0[krate].dependencies.iter().map(move |dep| (krate, dep))) + .collect() + } + + fn source(&'a self, edge: &Edge<'a>) -> CrateId { + edge.0 + } + + fn target(&'a self, edge: &Edge<'a>) -> CrateId { + edge.1.crate_id + } +} + +impl<'a> dot::Labeller<'a, CrateId, Edge<'a>> for DotCrateGraph { + fn graph_id(&'a self) -> Id<'a> { + Id::new("rust_analyzer_crate_graph").unwrap() + } + + fn node_id(&'a self, n: &CrateId) -> Id<'a> { + let name = self.0[*n].display_name.as_ref().map_or("_missing_name_", |name| &*name); + Id::new(name).unwrap() + } +} diff --git a/crates/rust-analyzer/src/handlers.rs b/crates/rust-analyzer/src/handlers.rs index f6e40f872228..dafbab6d094f 100644 --- a/crates/rust-analyzer/src/handlers.rs +++ b/crates/rust-analyzer/src/handlers.rs @@ -117,6 +117,12 @@ pub(crate) fn handle_view_hir( Ok(res) } +pub(crate) fn handle_view_crate_graph(snap: GlobalStateSnapshot, (): ()) -> Result { + let _p = profile::span("handle_view_crate_graph"); + let res = snap.analysis.view_crate_graph()??; + Ok(res) +} + pub(crate) fn handle_expand_macro( snap: GlobalStateSnapshot, params: lsp_ext::ExpandMacroParams, diff --git a/crates/rust-analyzer/src/lsp_ext.rs b/crates/rust-analyzer/src/lsp_ext.rs index b8835a5349be..3bd09805800b 100644 --- a/crates/rust-analyzer/src/lsp_ext.rs +++ b/crates/rust-analyzer/src/lsp_ext.rs @@ -61,6 +61,14 @@ impl Request for ViewHir { const METHOD: &'static str = "rust-analyzer/viewHir"; } +pub enum ViewCrateGraph {} + +impl Request for ViewCrateGraph { + type Params = (); + type Result = String; + const METHOD: &'static str = "rust-analyzer/viewCrateGraph"; +} + pub enum ExpandMacro {} impl Request for ExpandMacro { diff --git a/crates/rust-analyzer/src/main_loop.rs b/crates/rust-analyzer/src/main_loop.rs index ce7ece559fbd..c7bd7eee1a90 100644 --- a/crates/rust-analyzer/src/main_loop.rs +++ b/crates/rust-analyzer/src/main_loop.rs @@ -513,6 +513,7 @@ impl GlobalState { .on::(handlers::handle_analyzer_status) .on::(handlers::handle_syntax_tree) .on::(handlers::handle_view_hir) + .on::(handlers::handle_view_crate_graph) .on::(handlers::handle_expand_macro) .on::(handlers::handle_parent_module) .on::(handlers::handle_runnables) diff --git a/editors/code/package.json b/editors/code/package.json index f35d30898f71..0f38a1673ac0 100644 --- a/editors/code/package.json +++ b/editors/code/package.json @@ -109,6 +109,11 @@ "title": "View Hir", "category": "Rust Analyzer" }, + { + "command": "rust-analyzer.viewCrateGraph", + "title": "View Crate Graph", + "category": "Rust Analyzer" + }, { "command": "rust-analyzer.expandMacro", "title": "Expand macro recursively", diff --git a/editors/code/src/commands.ts b/editors/code/src/commands.ts index 4092435dbe77..8ab259af2211 100644 --- a/editors/code/src/commands.ts +++ b/editors/code/src/commands.ts @@ -429,6 +429,14 @@ export function viewHir(ctx: Ctx): Cmd { }; } +export function viewCrateGraph(ctx: Ctx): Cmd { + return async () => { + const panel = vscode.window.createWebviewPanel("rust-analyzer.crate-graph", "rust-analyzer crate graph", vscode.ViewColumn.Two); + const svg = await ctx.client.sendRequest(ra.viewCrateGraph); + panel.webview.html = svg; + }; +} + // Opens the virtual file that will show the syntax tree // // The contents of the file come from the `TextDocumentContentProvider` diff --git a/editors/code/src/lsp_ext.ts b/editors/code/src/lsp_ext.ts index f78de894b54f..aa745a65ce60 100644 --- a/editors/code/src/lsp_ext.ts +++ b/editors/code/src/lsp_ext.ts @@ -27,6 +27,8 @@ export const syntaxTree = new lc.RequestType("ru export const viewHir = new lc.RequestType("rust-analyzer/viewHir"); +export const viewCrateGraph = new lc.RequestType0("rust-analyzer/viewCrateGraph"); + export interface ExpandMacroParams { textDocument: lc.TextDocumentIdentifier; position: lc.Position; diff --git a/editors/code/src/main.ts b/editors/code/src/main.ts index 643fb643f3a6..516322d035d4 100644 --- a/editors/code/src/main.ts +++ b/editors/code/src/main.ts @@ -106,6 +106,7 @@ async function tryActivate(context: vscode.ExtensionContext) { ctx.registerCommand('parentModule', commands.parentModule); ctx.registerCommand('syntaxTree', commands.syntaxTree); ctx.registerCommand('viewHir', commands.viewHir); + ctx.registerCommand('viewCrateGraph', commands.viewCrateGraph); ctx.registerCommand('expandMacro', commands.expandMacro); ctx.registerCommand('run', commands.run); ctx.registerCommand('copyRunCommandLine', commands.copyRunCommandLine); From 435c422963ef16a42070356e350c89670979e2d0 Mon Sep 17 00:00:00 2001 From: Jonas Schievink Date: Tue, 11 May 2021 16:36:00 +0200 Subject: [PATCH 2/6] Distinguish crates with identical name --- crates/ide/src/view_crate_graph.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/ide/src/view_crate_graph.rs b/crates/ide/src/view_crate_graph.rs index 4da4ce2b379f..8aa59817096d 100644 --- a/crates/ide/src/view_crate_graph.rs +++ b/crates/ide/src/view_crate_graph.rs @@ -76,6 +76,6 @@ impl<'a> dot::Labeller<'a, CrateId, Edge<'a>> for DotCrateGraph { fn node_id(&'a self, n: &CrateId) -> Id<'a> { let name = self.0[*n].display_name.as_ref().map_or("_missing_name_", |name| &*name); - Id::new(name).unwrap() + Id::new(format!("{}_{}", name, n.0)).unwrap() } } From 9e6d9baf2e301b9aebd6ae8802961bc53426200e Mon Sep 17 00:00:00 2001 From: Jonas Schievink Date: Tue, 11 May 2021 16:42:27 +0200 Subject: [PATCH 3/6] Update crates/ide/src/view_crate_graph.rs Co-authored-by: bjorn3 --- crates/ide/src/view_crate_graph.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/crates/ide/src/view_crate_graph.rs b/crates/ide/src/view_crate_graph.rs index 8aa59817096d..45995bf58a65 100644 --- a/crates/ide/src/view_crate_graph.rs +++ b/crates/ide/src/view_crate_graph.rs @@ -13,8 +13,8 @@ use ide_db::{ // Feature: View Crate Graph // -// Renders the currently loaded crate graph as an SVG graphic. Requires the `dot` tool to be -// installed. +// Renders the currently loaded crate graph as an SVG graphic. Requires the `dot` tool, which +// is part of graphviz, to be installed. // // |=== // | Editor | Action Name From b8d40a02a9cac5daf568aab172e1db8c73afbe12 Mon Sep 17 00:00:00 2001 From: Jonas Schievink Date: Tue, 11 May 2021 16:45:51 +0200 Subject: [PATCH 4/6] Document viewCrateGraph request --- docs/dev/lsp-extensions.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/dev/lsp-extensions.md b/docs/dev/lsp-extensions.md index f0f981802ef2..8fcd72d5d5df 100644 --- a/docs/dev/lsp-extensions.md +++ b/docs/dev/lsp-extensions.md @@ -1,5 +1,5 @@