diff options
Diffstat (limited to 'crates/ide/src')
-rw-r--r-- | crates/ide/src/lib.rs | 5 | ||||
-rw-r--r-- | crates/ide/src/view_crate_graph.rs | 111 |
2 files changed, 116 insertions, 0 deletions
diff --git a/crates/ide/src/lib.rs b/crates/ide/src/lib.rs index 8e5b72044..34360501a 100644 --- a/crates/ide/src/lib.rs +++ b/crates/ide/src/lib.rs | |||
@@ -49,6 +49,7 @@ mod syntax_tree; | |||
49 | mod typing; | 49 | mod typing; |
50 | mod markdown_remove; | 50 | mod markdown_remove; |
51 | mod doc_links; | 51 | mod doc_links; |
52 | mod view_crate_graph; | ||
52 | 53 | ||
53 | use std::sync::Arc; | 54 | use std::sync::Arc; |
54 | 55 | ||
@@ -287,6 +288,10 @@ impl Analysis { | |||
287 | self.with_db(|db| view_hir::view_hir(&db, position)) | 288 | self.with_db(|db| view_hir::view_hir(&db, position)) |
288 | } | 289 | } |
289 | 290 | ||
291 | pub fn view_crate_graph(&self) -> Cancelable<Result<String, String>> { | ||
292 | self.with_db(|db| view_crate_graph::view_crate_graph(&db)) | ||
293 | } | ||
294 | |||
290 | pub fn expand_macro(&self, position: FilePosition) -> Cancelable<Option<ExpandedMacro>> { | 295 | pub fn expand_macro(&self, position: FilePosition) -> Cancelable<Option<ExpandedMacro>> { |
291 | self.with_db(|db| expand_macro::expand_macro(db, position)) | 296 | self.with_db(|db| expand_macro::expand_macro(db, position)) |
292 | } | 297 | } |
diff --git a/crates/ide/src/view_crate_graph.rs b/crates/ide/src/view_crate_graph.rs new file mode 100644 index 000000000..5e4ba881e --- /dev/null +++ b/crates/ide/src/view_crate_graph.rs | |||
@@ -0,0 +1,111 @@ | |||
1 | use std::{ | ||
2 | error::Error, | ||
3 | io::{Read, Write}, | ||
4 | process::{Command, Stdio}, | ||
5 | sync::Arc, | ||
6 | }; | ||
7 | |||
8 | use dot::{Id, LabelText}; | ||
9 | use ide_db::{ | ||
10 | base_db::{CrateGraph, CrateId, Dependency, SourceDatabase, SourceDatabaseExt}, | ||
11 | RootDatabase, | ||
12 | }; | ||
13 | use rustc_hash::FxHashSet; | ||
14 | |||
15 | // Feature: View Crate Graph | ||
16 | // | ||
17 | // Renders the currently loaded crate graph as an SVG graphic. Requires the `dot` tool, which | ||
18 | // is part of graphviz, to be installed. | ||
19 | // | ||
20 | // Only workspace crates are included, no crates.io dependencies or sysroot crates. | ||
21 | // | ||
22 | // |=== | ||
23 | // | Editor | Action Name | ||
24 | // | ||
25 | // | VS Code | **Rust Analyzer: View Crate Graph** | ||
26 | // |=== | ||
27 | pub(crate) fn view_crate_graph(db: &RootDatabase) -> Result<String, String> { | ||
28 | let crate_graph = db.crate_graph(); | ||
29 | let crates_to_render = crate_graph | ||
30 | .iter() | ||
31 | .filter(|krate| { | ||
32 | // Only render workspace crates | ||
33 | let root_id = db.file_source_root(crate_graph[*krate].root_file_id); | ||
34 | !db.source_root(root_id).is_library | ||
35 | }) | ||
36 | .collect(); | ||
37 | let graph = DotCrateGraph { graph: crate_graph, crates_to_render }; | ||
38 | |||
39 | let mut dot = Vec::new(); | ||
40 | dot::render(&graph, &mut dot).unwrap(); | ||
41 | |||
42 | render_svg(&dot).map_err(|e| e.to_string()) | ||
43 | } | ||
44 | |||
45 | fn render_svg(dot: &[u8]) -> Result<String, Box<dyn Error>> { | ||
46 | // We shell out to `dot` to render to SVG, as there does not seem to be a pure-Rust renderer. | ||
47 | let child = Command::new("dot") | ||
48 | .arg("-Tsvg") | ||
49 | .stdin(Stdio::piped()) | ||
50 | .stdout(Stdio::piped()) | ||
51 | .spawn() | ||
52 | .map_err(|err| format!("failed to spawn `dot`: {}", err))?; | ||
53 | child.stdin.unwrap().write_all(&dot)?; | ||
54 | |||
55 | let mut svg = String::new(); | ||
56 | child.stdout.unwrap().read_to_string(&mut svg)?; | ||
57 | Ok(svg) | ||
58 | } | ||
59 | |||
60 | struct DotCrateGraph { | ||
61 | graph: Arc<CrateGraph>, | ||
62 | crates_to_render: FxHashSet<CrateId>, | ||
63 | } | ||
64 | |||
65 | type Edge<'a> = (CrateId, &'a Dependency); | ||
66 | |||
67 | impl<'a> dot::GraphWalk<'a, CrateId, Edge<'a>> for DotCrateGraph { | ||
68 | fn nodes(&'a self) -> dot::Nodes<'a, CrateId> { | ||
69 | self.crates_to_render.iter().copied().collect() | ||
70 | } | ||
71 | |||
72 | fn edges(&'a self) -> dot::Edges<'a, Edge<'a>> { | ||
73 | self.crates_to_render | ||
74 | .iter() | ||
75 | .flat_map(|krate| { | ||
76 | self.graph[*krate] | ||
77 | .dependencies | ||
78 | .iter() | ||
79 | .filter(|dep| self.crates_to_render.contains(&dep.crate_id)) | ||
80 | .map(move |dep| (*krate, dep)) | ||
81 | }) | ||
82 | .collect() | ||
83 | } | ||
84 | |||
85 | fn source(&'a self, edge: &Edge<'a>) -> CrateId { | ||
86 | edge.0 | ||
87 | } | ||
88 | |||
89 | fn target(&'a self, edge: &Edge<'a>) -> CrateId { | ||
90 | edge.1.crate_id | ||
91 | } | ||
92 | } | ||
93 | |||
94 | impl<'a> dot::Labeller<'a, CrateId, Edge<'a>> for DotCrateGraph { | ||
95 | fn graph_id(&'a self) -> Id<'a> { | ||
96 | Id::new("rust_analyzer_crate_graph").unwrap() | ||
97 | } | ||
98 | |||
99 | fn node_id(&'a self, n: &CrateId) -> Id<'a> { | ||
100 | Id::new(format!("_{}", n.0)).unwrap() | ||
101 | } | ||
102 | |||
103 | fn node_shape(&'a self, _node: &CrateId) -> Option<LabelText<'a>> { | ||
104 | Some(LabelText::LabelStr("box".into())) | ||
105 | } | ||
106 | |||
107 | fn node_label(&'a self, n: &CrateId) -> LabelText<'a> { | ||
108 | let name = self.graph[*n].display_name.as_ref().map_or("(unnamed crate)", |name| &*name); | ||
109 | LabelText::LabelStr(name.into()) | ||
110 | } | ||
111 | } | ||