aboutsummaryrefslogtreecommitdiff
path: root/crates/ra_project_model/src/cargo_workspace.rs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/ra_project_model/src/cargo_workspace.rs')
-rw-r--r--crates/ra_project_model/src/cargo_workspace.rs173
1 files changed, 173 insertions, 0 deletions
diff --git a/crates/ra_project_model/src/cargo_workspace.rs b/crates/ra_project_model/src/cargo_workspace.rs
new file mode 100644
index 000000000..f3e67d0e5
--- /dev/null
+++ b/crates/ra_project_model/src/cargo_workspace.rs
@@ -0,0 +1,173 @@
1use std::path::{Path, PathBuf};
2
3use cargo_metadata::{MetadataCommand, CargoOpt};
4use smol_str::SmolStr;
5use ra_arena::{Arena, RawId, impl_arena_id};
6use rustc_hash::FxHashMap;
7use failure::format_err;
8
9use crate::Result;
10
11/// `CargoWorkspace` represents the logical structure of, well, a Cargo
12/// workspace. It pretty closely mirrors `cargo metadata` output.
13///
14/// Note that internally, rust analyzer uses a different structure:
15/// `CrateGraph`. `CrateGraph` is lower-level: it knows only about the crates,
16/// while this knows about `Pacakges` & `Targets`: purely cargo-related
17/// concepts.
18#[derive(Debug, Clone)]
19pub struct CargoWorkspace {
20 packages: Arena<Package, PackageData>,
21 targets: Arena<Target, TargetData>,
22}
23
24#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
25pub struct Package(RawId);
26impl_arena_id!(Package);
27
28#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
29pub struct Target(RawId);
30impl_arena_id!(Target);
31
32#[derive(Debug, Clone)]
33struct PackageData {
34 name: SmolStr,
35 manifest: PathBuf,
36 targets: Vec<Target>,
37 is_member: bool,
38 dependencies: Vec<PackageDependency>,
39}
40
41#[derive(Debug, Clone)]
42pub struct PackageDependency {
43 pub pkg: Package,
44 pub name: SmolStr,
45}
46
47#[derive(Debug, Clone)]
48struct TargetData {
49 pkg: Package,
50 name: SmolStr,
51 root: PathBuf,
52 kind: TargetKind,
53}
54
55#[derive(Debug, Clone, Copy, PartialEq, Eq)]
56pub enum TargetKind {
57 Bin,
58 Lib,
59 Example,
60 Test,
61 Bench,
62 Other,
63}
64
65impl TargetKind {
66 fn new(kinds: &[String]) -> TargetKind {
67 for kind in kinds {
68 return match kind.as_str() {
69 "bin" => TargetKind::Bin,
70 "test" => TargetKind::Test,
71 "bench" => TargetKind::Bench,
72 "example" => TargetKind::Example,
73 _ if kind.contains("lib") => TargetKind::Lib,
74 _ => continue,
75 };
76 }
77 TargetKind::Other
78 }
79}
80
81impl Package {
82 pub fn name(self, ws: &CargoWorkspace) -> &str {
83 ws.packages[self].name.as_str()
84 }
85 pub fn root(self, ws: &CargoWorkspace) -> &Path {
86 ws.packages[self].manifest.parent().unwrap()
87 }
88 pub fn targets<'a>(self, ws: &'a CargoWorkspace) -> impl Iterator<Item = Target> + 'a {
89 ws.packages[self].targets.iter().cloned()
90 }
91 #[allow(unused)]
92 pub fn is_member(self, ws: &CargoWorkspace) -> bool {
93 ws.packages[self].is_member
94 }
95 pub fn dependencies<'a>(
96 self,
97 ws: &'a CargoWorkspace,
98 ) -> impl Iterator<Item = &'a PackageDependency> + 'a {
99 ws.packages[self].dependencies.iter()
100 }
101}
102
103impl Target {
104 pub fn package(self, ws: &CargoWorkspace) -> Package {
105 ws.targets[self].pkg
106 }
107 pub fn name(self, ws: &CargoWorkspace) -> &str {
108 ws.targets[self].name.as_str()
109 }
110 pub fn root(self, ws: &CargoWorkspace) -> &Path {
111 ws.targets[self].root.as_path()
112 }
113 pub fn kind(self, ws: &CargoWorkspace) -> TargetKind {
114 ws.targets[self].kind
115 }
116}
117
118impl CargoWorkspace {
119 pub fn from_cargo_metadata(cargo_toml: &Path) -> Result<CargoWorkspace> {
120 let mut meta = MetadataCommand::new();
121 meta.manifest_path(cargo_toml).features(CargoOpt::AllFeatures);
122 if let Some(parent) = cargo_toml.parent() {
123 meta.current_dir(parent);
124 }
125 let meta = meta.exec().map_err(|e| format_err!("cargo metadata failed: {}", e))?;
126 let mut pkg_by_id = FxHashMap::default();
127 let mut packages = Arena::default();
128 let mut targets = Arena::default();
129
130 let ws_members = &meta.workspace_members;
131
132 for meta_pkg in meta.packages {
133 let is_member = ws_members.contains(&meta_pkg.id);
134 let pkg = packages.alloc(PackageData {
135 name: meta_pkg.name.into(),
136 manifest: meta_pkg.manifest_path.clone(),
137 targets: Vec::new(),
138 is_member,
139 dependencies: Vec::new(),
140 });
141 let pkg_data = &mut packages[pkg];
142 pkg_by_id.insert(meta_pkg.id.clone(), pkg);
143 for meta_tgt in meta_pkg.targets {
144 let tgt = targets.alloc(TargetData {
145 pkg,
146 name: meta_tgt.name.into(),
147 root: meta_tgt.src_path.clone(),
148 kind: TargetKind::new(meta_tgt.kind.as_slice()),
149 });
150 pkg_data.targets.push(tgt);
151 }
152 }
153 let resolve = meta.resolve.expect("metadata executed with deps");
154 for node in resolve.nodes {
155 let source = pkg_by_id[&node.id];
156 for dep_node in node.deps {
157 let dep =
158 PackageDependency { name: dep_node.name.into(), pkg: pkg_by_id[&dep_node.pkg] };
159 packages[source].dependencies.push(dep);
160 }
161 }
162
163 Ok(CargoWorkspace { packages, targets })
164 }
165
166 pub fn packages<'a>(&'a self) -> impl Iterator<Item = Package> + 'a {
167 self.packages.iter().map(|(id, _pkg)| id)
168 }
169
170 pub fn target_by_root(&self, root: &Path) -> Option<Target> {
171 self.packages().filter_map(|pkg| pkg.targets(self).find(|it| it.root(self) == root)).next()
172 }
173}