356 lines
14 KiB
Rust
356 lines
14 KiB
Rust
//! FIXME: write short doc here
|
|
|
|
mod cargo_workspace;
|
|
mod json_project;
|
|
mod sysroot;
|
|
|
|
use std::{
|
|
error::Error,
|
|
fs::File,
|
|
io::BufReader,
|
|
path::{Path, PathBuf},
|
|
process::Command,
|
|
};
|
|
|
|
use ra_cfg::CfgOptions;
|
|
use ra_db::{CrateGraph, CrateId, Edition, FileId};
|
|
use rustc_hash::FxHashMap;
|
|
use serde_json::from_reader;
|
|
|
|
pub use crate::{
|
|
cargo_workspace::{CargoWorkspace, Package, Target, TargetKind},
|
|
json_project::JsonProject,
|
|
sysroot::Sysroot,
|
|
};
|
|
|
|
// FIXME use proper error enum
|
|
pub type Result<T> = ::std::result::Result<T, Box<dyn Error + Send + Sync>>;
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub enum ProjectWorkspace {
|
|
/// Project workspace was discovered by running `cargo metadata` and `rustc --print sysroot`.
|
|
Cargo { cargo: CargoWorkspace, sysroot: Sysroot },
|
|
/// Project workspace was manually specified using a `rust-project.json` file.
|
|
Json { project: JsonProject },
|
|
}
|
|
|
|
/// `PackageRoot` describes a package root folder.
|
|
/// Which may be an external dependency, or a member of
|
|
/// the current workspace.
|
|
#[derive(Clone)]
|
|
pub struct PackageRoot {
|
|
/// Path to the root folder
|
|
path: PathBuf,
|
|
/// Is a member of the current workspace
|
|
is_member: bool,
|
|
}
|
|
|
|
impl PackageRoot {
|
|
pub fn new(path: PathBuf, is_member: bool) -> PackageRoot {
|
|
PackageRoot { path, is_member }
|
|
}
|
|
|
|
pub fn path(&self) -> &PathBuf {
|
|
&self.path
|
|
}
|
|
|
|
pub fn is_member(&self) -> bool {
|
|
self.is_member
|
|
}
|
|
}
|
|
|
|
impl ProjectWorkspace {
|
|
pub fn discover(path: &Path) -> Result<ProjectWorkspace> {
|
|
ProjectWorkspace::discover_with_sysroot(path, true)
|
|
}
|
|
|
|
pub fn discover_with_sysroot(path: &Path, with_sysroot: bool) -> Result<ProjectWorkspace> {
|
|
match find_rust_project_json(path) {
|
|
Some(json_path) => {
|
|
let file = File::open(json_path)?;
|
|
let reader = BufReader::new(file);
|
|
Ok(ProjectWorkspace::Json { project: from_reader(reader)? })
|
|
}
|
|
None => {
|
|
let cargo_toml = find_cargo_toml(path)?;
|
|
let cargo = CargoWorkspace::from_cargo_metadata(&cargo_toml)?;
|
|
let sysroot =
|
|
if with_sysroot { Sysroot::discover(&cargo_toml)? } else { Sysroot::default() };
|
|
Ok(ProjectWorkspace::Cargo { cargo, sysroot })
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Returns the roots for the current `ProjectWorkspace`
|
|
/// The return type contains the path and whether or not
|
|
/// the root is a member of the current workspace
|
|
pub fn to_roots(&self) -> Vec<PackageRoot> {
|
|
match self {
|
|
ProjectWorkspace::Json { project } => {
|
|
let mut roots = Vec::with_capacity(project.roots.len());
|
|
for root in &project.roots {
|
|
roots.push(PackageRoot::new(root.path.clone(), true));
|
|
}
|
|
roots
|
|
}
|
|
ProjectWorkspace::Cargo { cargo, sysroot } => {
|
|
let mut roots = Vec::with_capacity(cargo.packages().len() + sysroot.crates().len());
|
|
for pkg in cargo.packages() {
|
|
let root = pkg.root(&cargo).to_path_buf();
|
|
let member = pkg.is_member(&cargo);
|
|
roots.push(PackageRoot::new(root, member));
|
|
}
|
|
for krate in sysroot.crates() {
|
|
roots.push(PackageRoot::new(krate.root_dir(&sysroot).to_path_buf(), false))
|
|
}
|
|
roots
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn n_packages(&self) -> usize {
|
|
match self {
|
|
ProjectWorkspace::Json { project } => project.crates.len(),
|
|
ProjectWorkspace::Cargo { cargo, sysroot } => {
|
|
cargo.packages().len() + sysroot.crates().len()
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn to_crate_graph(
|
|
&self,
|
|
default_cfg_options: &CfgOptions,
|
|
load: &mut dyn FnMut(&Path) -> Option<FileId>,
|
|
) -> (CrateGraph, FxHashMap<CrateId, String>) {
|
|
let mut crate_graph = CrateGraph::default();
|
|
let mut names = FxHashMap::default();
|
|
match self {
|
|
ProjectWorkspace::Json { project } => {
|
|
let mut crates = FxHashMap::default();
|
|
for (id, krate) in project.crates.iter().enumerate() {
|
|
let crate_id = json_project::CrateId(id);
|
|
if let Some(file_id) = load(&krate.root_module) {
|
|
let edition = match krate.edition {
|
|
json_project::Edition::Edition2015 => Edition::Edition2015,
|
|
json_project::Edition::Edition2018 => Edition::Edition2018,
|
|
};
|
|
let cfg_options = {
|
|
let mut opts = default_cfg_options.clone();
|
|
for name in &krate.atom_cfgs {
|
|
opts.insert_atom(name.into());
|
|
}
|
|
for (key, value) in &krate.key_value_cfgs {
|
|
opts.insert_key_value(key.into(), value.into());
|
|
}
|
|
opts
|
|
};
|
|
crates.insert(
|
|
crate_id,
|
|
crate_graph.add_crate_root(file_id, edition, cfg_options),
|
|
);
|
|
}
|
|
}
|
|
|
|
for (id, krate) in project.crates.iter().enumerate() {
|
|
for dep in &krate.deps {
|
|
let from_crate_id = json_project::CrateId(id);
|
|
let to_crate_id = dep.krate;
|
|
if let (Some(&from), Some(&to)) =
|
|
(crates.get(&from_crate_id), crates.get(&to_crate_id))
|
|
{
|
|
if let Err(_) = crate_graph.add_dep(from, dep.name.clone().into(), to) {
|
|
log::error!(
|
|
"cyclic dependency {:?} -> {:?}",
|
|
from_crate_id,
|
|
to_crate_id
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
ProjectWorkspace::Cargo { cargo, sysroot } => {
|
|
let mut sysroot_crates = FxHashMap::default();
|
|
for krate in sysroot.crates() {
|
|
if let Some(file_id) = load(krate.root(&sysroot)) {
|
|
// Crates from sysroot have `cfg(test)` disabled
|
|
let cfg_options = {
|
|
let mut opts = default_cfg_options.clone();
|
|
opts.remove_atom("test");
|
|
opts
|
|
};
|
|
|
|
let crate_id =
|
|
crate_graph.add_crate_root(file_id, Edition::Edition2018, cfg_options);
|
|
sysroot_crates.insert(krate, crate_id);
|
|
names.insert(crate_id, krate.name(&sysroot).to_string());
|
|
}
|
|
}
|
|
for from in sysroot.crates() {
|
|
for to in from.deps(&sysroot) {
|
|
let name = to.name(&sysroot);
|
|
if let (Some(&from), Some(&to)) =
|
|
(sysroot_crates.get(&from), sysroot_crates.get(&to))
|
|
{
|
|
if let Err(_) = crate_graph.add_dep(from, name.into(), to) {
|
|
log::error!("cyclic dependency between sysroot crates")
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
let libstd = sysroot.std().and_then(|it| sysroot_crates.get(&it).copied());
|
|
|
|
let mut pkg_to_lib_crate = FxHashMap::default();
|
|
let mut pkg_crates = FxHashMap::default();
|
|
// Next, create crates for each package, target pair
|
|
for pkg in cargo.packages() {
|
|
let mut lib_tgt = None;
|
|
for tgt in pkg.targets(&cargo) {
|
|
let root = tgt.root(&cargo);
|
|
if let Some(file_id) = load(root) {
|
|
let edition = pkg.edition(&cargo);
|
|
let cfg_options = {
|
|
let mut opts = default_cfg_options.clone();
|
|
opts.insert_features(pkg.features(&cargo).iter().map(Into::into));
|
|
opts
|
|
};
|
|
let crate_id =
|
|
crate_graph.add_crate_root(file_id, edition, cfg_options);
|
|
names.insert(crate_id, pkg.name(&cargo).to_string());
|
|
if tgt.kind(&cargo) == TargetKind::Lib {
|
|
lib_tgt = Some(crate_id);
|
|
pkg_to_lib_crate.insert(pkg, crate_id);
|
|
}
|
|
pkg_crates.entry(pkg).or_insert_with(Vec::new).push(crate_id);
|
|
}
|
|
}
|
|
|
|
// Set deps to the std and to the lib target of the current package
|
|
for &from in pkg_crates.get(&pkg).into_iter().flatten() {
|
|
if let Some(to) = lib_tgt {
|
|
if to != from {
|
|
if let Err(_) =
|
|
crate_graph.add_dep(from, pkg.name(&cargo).into(), to)
|
|
{
|
|
log::error!(
|
|
"cyclic dependency between targets of {}",
|
|
pkg.name(&cargo)
|
|
)
|
|
}
|
|
}
|
|
}
|
|
if let Some(std) = libstd {
|
|
if let Err(_) = crate_graph.add_dep(from, "std".into(), std) {
|
|
log::error!("cyclic dependency on std for {}", pkg.name(&cargo))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Now add a dep edge from all targets of upstream to the lib
|
|
// target of downstream.
|
|
for pkg in cargo.packages() {
|
|
for dep in pkg.dependencies(&cargo) {
|
|
if let Some(&to) = pkg_to_lib_crate.get(&dep.pkg) {
|
|
for &from in pkg_crates.get(&pkg).into_iter().flatten() {
|
|
if let Err(_) =
|
|
crate_graph.add_dep(from, dep.name.clone().into(), to)
|
|
{
|
|
log::error!(
|
|
"cyclic dependency {} -> {}",
|
|
pkg.name(&cargo),
|
|
dep.pkg.name(&cargo)
|
|
)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
(crate_graph, names)
|
|
}
|
|
|
|
pub fn workspace_root_for(&self, path: &Path) -> Option<&Path> {
|
|
match self {
|
|
ProjectWorkspace::Cargo { cargo, .. } => {
|
|
Some(cargo.workspace_root.as_ref()).filter(|root| path.starts_with(root))
|
|
}
|
|
ProjectWorkspace::Json { project: JsonProject { roots, .. } } => roots
|
|
.iter()
|
|
.find(|root| path.starts_with(&root.path))
|
|
.map(|root| root.path.as_ref()),
|
|
}
|
|
}
|
|
}
|
|
|
|
fn find_rust_project_json(path: &Path) -> Option<PathBuf> {
|
|
if path.ends_with("rust-project.json") {
|
|
return Some(path.to_path_buf());
|
|
}
|
|
|
|
let mut curr = Some(path);
|
|
while let Some(path) = curr {
|
|
let candidate = path.join("rust-project.json");
|
|
if candidate.exists() {
|
|
return Some(candidate);
|
|
}
|
|
curr = path.parent();
|
|
}
|
|
|
|
None
|
|
}
|
|
|
|
fn find_cargo_toml(path: &Path) -> Result<PathBuf> {
|
|
if path.ends_with("Cargo.toml") {
|
|
return Ok(path.to_path_buf());
|
|
}
|
|
let mut curr = Some(path);
|
|
while let Some(path) = curr {
|
|
let candidate = path.join("Cargo.toml");
|
|
if candidate.exists() {
|
|
return Ok(candidate);
|
|
}
|
|
curr = path.parent();
|
|
}
|
|
Err(format!("can't find Cargo.toml at {}", path.display()))?
|
|
}
|
|
|
|
pub fn get_rustc_cfg_options() -> CfgOptions {
|
|
let mut cfg_options = CfgOptions::default();
|
|
|
|
// Some nightly-only cfgs, which are required for stdlib
|
|
{
|
|
cfg_options.insert_atom("target_thread_local".into());
|
|
for &target_has_atomic in ["16", "32", "64", "8", "cas", "ptr"].iter() {
|
|
cfg_options.insert_key_value("target_has_atomic".into(), target_has_atomic.into())
|
|
}
|
|
}
|
|
|
|
match (|| -> Result<_> {
|
|
// `cfg(test)` and `cfg(debug_assertion)` are handled outside, so we suppress them here.
|
|
let output = Command::new("rustc").args(&["--print", "cfg", "-O"]).output()?;
|
|
if !output.status.success() {
|
|
Err("failed to get rustc cfgs")?;
|
|
}
|
|
Ok(String::from_utf8(output.stdout)?)
|
|
})() {
|
|
Ok(rustc_cfgs) => {
|
|
for line in rustc_cfgs.lines() {
|
|
match line.find('=') {
|
|
None => cfg_options.insert_atom(line.into()),
|
|
Some(pos) => {
|
|
let key = &line[..pos];
|
|
let value = line[pos + 1..].trim_matches('"');
|
|
cfg_options.insert_key_value(key.into(), value.into());
|
|
}
|
|
}
|
|
}
|
|
}
|
|
Err(e) => log::error!("failed to get rustc cfgs: {}", e),
|
|
}
|
|
|
|
cfg_options
|
|
}
|