//! FIXME: write short doc here
mod cargo_workspace;
-mod json_project;
+mod project_json;
mod sysroot;
use std::{
- error::Error,
fs::{read_dir, File, ReadDir},
- io::BufReader,
- path::{Path, PathBuf},
- process::Command,
+ io::{self, BufReader},
+ path::Path,
+ process::{Command, Output},
};
use anyhow::{bail, Context, Result};
+use paths::{AbsPath, AbsPathBuf};
use ra_cfg::CfgOptions;
-use ra_db::{CrateGraph, CrateName, Edition, Env, ExternSource, ExternSourceId, FileId};
-use rustc_hash::FxHashMap;
+use ra_db::{CrateGraph, CrateName, Edition, Env, FileId};
+use rustc_hash::{FxHashMap, FxHashSet};
use serde_json::from_reader;
pub use crate::{
cargo_workspace::{CargoConfig, CargoWorkspace, Package, Target, TargetKind},
- json_project::JsonProject,
+ project_json::ProjectJson,
sysroot::Sysroot,
};
pub use ra_proc_macro::ProcMacroClient;
-#[derive(Clone, PartialEq, Eq, Hash, Debug)]
-pub struct CargoTomlNotFoundError {
- pub searched_at: PathBuf,
- pub reason: String,
-}
-
-impl std::fmt::Display for CargoTomlNotFoundError {
- fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
- write!(
- fmt,
- "can't find Cargo.toml at {}, due to {}",
- self.searched_at.display(),
- self.reason
- )
- }
-}
-
-impl Error for CargoTomlNotFoundError {}
-
#[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 },
+ Json { project: ProjectJson, project_location: AbsPathBuf },
}
/// `PackageRoot` describes a package root folder.
/// Which may be an external dependency, or a member of
/// the current workspace.
-#[derive(Clone)]
+#[derive(Debug, Clone)]
pub struct PackageRoot {
/// Path to the root folder
- path: PathBuf,
+ path: AbsPathBuf,
/// Is a member of the current workspace
is_member: bool,
+ out_dir: Option<AbsPathBuf>,
}
impl PackageRoot {
- pub fn new_member(path: PathBuf) -> PackageRoot {
- Self { path, is_member: true }
+ pub fn new_member(path: AbsPathBuf) -> PackageRoot {
+ Self { path, is_member: true, out_dir: None }
}
- pub fn new_non_member(path: PathBuf) -> PackageRoot {
- Self { path, is_member: false }
+ pub fn new_non_member(path: AbsPathBuf) -> PackageRoot {
+ Self { path, is_member: false, out_dir: None }
}
- pub fn path(&self) -> &Path {
+ pub fn path(&self) -> &AbsPath {
&self.path
}
+ pub fn out_dir(&self) -> Option<&AbsPath> {
+ self.out_dir.as_deref()
+ }
pub fn is_member(&self) -> bool {
self.is_member
}
}
-impl ProjectWorkspace {
- pub fn discover(path: &Path, cargo_features: &CargoConfig) -> Result<ProjectWorkspace> {
- ProjectWorkspace::discover_with_sysroot(path, true, cargo_features)
+#[derive(Debug, Clone, PartialEq, Eq, Hash, Ord, PartialOrd)]
+pub enum ProjectManifest {
+ ProjectJson(AbsPathBuf),
+ CargoToml(AbsPathBuf),
+}
+
+impl ProjectManifest {
+ pub fn from_manifest_file(path: AbsPathBuf) -> Result<ProjectManifest> {
+ if path.ends_with("rust-project.json") {
+ return Ok(ProjectManifest::ProjectJson(path));
+ }
+ if path.ends_with("Cargo.toml") {
+ return Ok(ProjectManifest::CargoToml(path));
+ }
+ bail!("project root must point to Cargo.toml or rust-project.json: {}", path.display())
}
- pub fn discover_with_sysroot(
- path: &Path,
- with_sysroot: bool,
+ pub fn discover_single(path: &AbsPath) -> Result<ProjectManifest> {
+ let mut candidates = ProjectManifest::discover(path)?;
+ let res = match candidates.pop() {
+ None => bail!("no projects"),
+ Some(it) => it,
+ };
+
+ if !candidates.is_empty() {
+ bail!("more than one project")
+ }
+ Ok(res)
+ }
+
+ pub fn discover(path: &AbsPath) -> io::Result<Vec<ProjectManifest>> {
+ if let Some(project_json) = find_in_parent_dirs(path, "rust-project.json") {
+ return Ok(vec![ProjectManifest::ProjectJson(project_json)]);
+ }
+ return find_cargo_toml(path)
+ .map(|paths| paths.into_iter().map(ProjectManifest::CargoToml).collect());
+
+ fn find_cargo_toml(path: &AbsPath) -> io::Result<Vec<AbsPathBuf>> {
+ match find_in_parent_dirs(path, "Cargo.toml") {
+ Some(it) => Ok(vec![it]),
+ None => Ok(find_cargo_toml_in_child_dir(read_dir(path)?)),
+ }
+ }
+
+ fn find_in_parent_dirs(path: &AbsPath, target_file_name: &str) -> Option<AbsPathBuf> {
+ if path.ends_with(target_file_name) {
+ return Some(path.to_path_buf());
+ }
+
+ let mut curr = Some(path);
+
+ while let Some(path) = curr {
+ let candidate = path.join(target_file_name);
+ if candidate.exists() {
+ return Some(candidate);
+ }
+ curr = path.parent();
+ }
+
+ None
+ }
+
+ fn find_cargo_toml_in_child_dir(entities: ReadDir) -> Vec<AbsPathBuf> {
+ // Only one level down to avoid cycles the easy way and stop a runaway scan with large projects
+ entities
+ .filter_map(Result::ok)
+ .map(|it| it.path().join("Cargo.toml"))
+ .filter(|it| it.exists())
+ .map(AbsPathBuf::assert)
+ .collect()
+ }
+ }
+
+ pub fn discover_all(paths: &[impl AsRef<AbsPath>]) -> Vec<ProjectManifest> {
+ let mut res = paths
+ .iter()
+ .filter_map(|it| ProjectManifest::discover(it.as_ref()).ok())
+ .flatten()
+ .collect::<FxHashSet<_>>()
+ .into_iter()
+ .collect::<Vec<_>>();
+ res.sort();
+ res
+ }
+}
+
+impl ProjectWorkspace {
+ pub fn load(
+ manifest: ProjectManifest,
cargo_features: &CargoConfig,
+ with_sysroot: bool,
) -> Result<ProjectWorkspace> {
- match find_rust_project_json(path) {
- Some(json_path) => {
- let file = File::open(&json_path)
- .with_context(|| format!("Failed to open json file {}", json_path.display()))?;
+ let res = match manifest {
+ ProjectManifest::ProjectJson(project_json) => {
+ let file = File::open(&project_json).with_context(|| {
+ format!("Failed to open json file {}", project_json.display())
+ })?;
let reader = BufReader::new(file);
- Ok(ProjectWorkspace::Json {
+ let project_location = project_json.parent().unwrap().to_path_buf();
+ ProjectWorkspace::Json {
project: from_reader(reader).with_context(|| {
- format!("Failed to deserialize json file {}", json_path.display())
+ format!("Failed to deserialize json file {}", project_json.display())
})?,
- })
+ project_location,
+ }
}
- None => {
- let cargo_toml = find_cargo_toml(path).with_context(|| {
- format!("Failed to find Cargo.toml for path {}", path.display())
- })?;
+ ProjectManifest::CargoToml(cargo_toml) => {
let cargo = CargoWorkspace::from_cargo_metadata(&cargo_toml, cargo_features)
.with_context(|| {
format!(
} else {
Sysroot::default()
};
- Ok(ProjectWorkspace::Cargo { cargo, sysroot })
+ ProjectWorkspace::Cargo { cargo, sysroot }
}
- }
+ };
+
+ Ok(res)
}
/// Returns the roots for the current `ProjectWorkspace`
/// the root is a member of the current workspace
pub fn to_roots(&self) -> Vec<PackageRoot> {
match self {
- ProjectWorkspace::Json { project } => {
- project.roots.iter().map(|r| PackageRoot::new_member(r.path.clone())).collect()
- }
+ ProjectWorkspace::Json { project, project_location } => project
+ .roots
+ .iter()
+ .map(|r| PackageRoot::new_member(project_location.join(&r.path)))
+ .collect(),
ProjectWorkspace::Cargo { cargo, sysroot } => cargo
.packages()
.map(|pkg| PackageRoot {
path: cargo[pkg].root().to_path_buf(),
is_member: cargo[pkg].is_member,
+ out_dir: cargo[pkg].out_dir.clone(),
})
.chain(sysroot.crates().map(|krate| {
PackageRoot::new_non_member(sysroot[krate].root_dir().to_path_buf())
}
}
- pub fn out_dirs(&self) -> Vec<PathBuf> {
+ pub fn proc_macro_dylib_paths(&self) -> Vec<AbsPathBuf> {
match self {
- ProjectWorkspace::Json { project } => {
- project.crates.iter().filter_map(|krate| krate.out_dir.as_ref()).cloned().collect()
- }
- ProjectWorkspace::Cargo { cargo, sysroot: _ } => {
- cargo.packages().filter_map(|pkg| cargo[pkg].out_dir.as_ref()).cloned().collect()
- }
- }
- }
-
- pub fn proc_macro_dylib_paths(&self) -> Vec<PathBuf> {
- match self {
- ProjectWorkspace::Json { project } => project
+ ProjectWorkspace::Json { project, project_location } => project
.crates
.iter()
.filter_map(|krate| krate.proc_macro_dylib_path.as_ref())
- .cloned()
+ .map(|it| project_location.join(it))
.collect(),
ProjectWorkspace::Cargo { cargo, sysroot: _sysroot } => cargo
.packages()
pub fn n_packages(&self) -> usize {
match self {
- ProjectWorkspace::Json { project } => project.crates.len(),
+ 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,
- extern_source_roots: &FxHashMap<PathBuf, ExternSourceId>,
+ target: Option<&str>,
proc_macro_client: &ProcMacroClient,
load: &mut dyn FnMut(&Path) -> Option<FileId>,
) -> CrateGraph {
let mut crate_graph = CrateGraph::default();
match self {
- ProjectWorkspace::Json { project } => {
+ ProjectWorkspace::Json { project, project_location } => {
let crates: FxHashMap<_, _> = project
.crates
.iter()
.enumerate()
.filter_map(|(seq_index, krate)| {
- let file_id = load(&krate.root_module)?;
+ let file_path = project_location.join(&krate.root_module);
+ let file_id = load(&file_path)?;
let edition = match krate.edition {
- json_project::Edition::Edition2015 => Edition::Edition2015,
- json_project::Edition::Edition2018 => Edition::Edition2018,
+ project_json::Edition::Edition2015 => Edition::Edition2015,
+ project_json::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());
+ let mut opts = CfgOptions::default();
+ for cfg in &krate.cfg {
+ match cfg.find('=') {
+ None => opts.insert_atom(cfg.into()),
+ Some(pos) => {
+ let key = &cfg[..pos];
+ let value = cfg[pos + 1..].trim_matches('"');
+ opts.insert_key_value(key.into(), value.into());
+ }
+ }
}
opts
};
let mut env = Env::default();
- let mut extern_source = ExternSource::default();
if let Some(out_dir) = &krate.out_dir {
- // FIXME: We probably mangle non UTF-8 paths here, figure out a better solution
- env.set("OUT_DIR", out_dir.to_string_lossy().to_string());
- if let Some(&extern_source_id) = extern_source_roots.get(out_dir) {
- extern_source.set_extern_path(&out_dir, extern_source_id);
+ // NOTE: cargo and rustc seem to hide non-UTF-8 strings from env! and option_env!()
+ if let Some(out_dir) = out_dir.to_str().map(|s| s.to_owned()) {
+ env.set("OUT_DIR", out_dir);
}
}
let proc_macro = krate
.map(|it| proc_macro_client.by_dylib_path(&it));
// FIXME: No crate name in json definition such that we cannot add OUT_DIR to env
Some((
- json_project::CrateId(seq_index),
+ project_json::CrateId(seq_index),
crate_graph.add_crate_root(
file_id,
edition,
None,
cfg_options,
env,
- extern_source,
proc_macro.unwrap_or_default(),
),
))
for (id, krate) in project.crates.iter().enumerate() {
for dep in &krate.deps {
- let from_crate_id = json_project::CrateId(id);
+ let from_crate_id = project_json::CrateId(id);
let to_crate_id = dep.krate;
if let (Some(&from), Some(&to)) =
(crates.get(&from_crate_id), crates.get(&to_crate_id))
}
}
ProjectWorkspace::Cargo { cargo, sysroot } => {
+ let mut cfg_options = get_rustc_cfg_options(target);
+
let sysroot_crates: FxHashMap<_, _> = sysroot
.crates()
.filter_map(|krate| {
let file_id = load(&sysroot[krate].root)?;
- // Crates from sysroot have `cfg(test)` disabled
- let cfg_options = {
- let mut opts = default_cfg_options.clone();
- opts.remove_atom("test");
- opts
- };
-
let env = Env::default();
- let extern_source = ExternSource::default();
let proc_macro = vec![];
let crate_name = CrateName::new(&sysroot[krate].name)
.expect("Sysroot crate names should not contain dashes");
file_id,
Edition::Edition2018,
Some(crate_name),
- cfg_options,
+ cfg_options.clone(),
env,
- extern_source,
proc_macro,
);
Some((krate, crate_id))
let mut pkg_to_lib_crate = FxHashMap::default();
let mut pkg_crates = FxHashMap::default();
+
+ // Add test cfg for non-sysroot crates
+ cfg_options.insert_atom("test".into());
+
// Next, create crates for each package, target pair
for pkg in cargo.packages() {
let mut lib_tgt = None;
if let Some(file_id) = load(root) {
let edition = cargo[pkg].edition;
let cfg_options = {
- let mut opts = default_cfg_options.clone();
- opts.insert_features(cargo[pkg].features.iter().map(Into::into));
+ let mut opts = cfg_options.clone();
+ for feature in cargo[pkg].features.iter() {
+ opts.insert_key_value("feature".into(), feature.into());
+ }
+ for cfg in cargo[pkg].cfgs.iter() {
+ match cfg.find('=') {
+ Some(split) => opts.insert_key_value(
+ cfg[..split].into(),
+ cfg[split + 1..].trim_matches('"').into(),
+ ),
+ None => opts.insert_atom(cfg.into()),
+ };
+ }
opts
};
let mut env = Env::default();
- let mut extern_source = ExternSource::default();
if let Some(out_dir) = &cargo[pkg].out_dir {
- // FIXME: We probably mangle non UTF-8 paths here, figure out a better solution
- env.set("OUT_DIR", out_dir.to_string_lossy().to_string());
- if let Some(&extern_source_id) = extern_source_roots.get(out_dir) {
- extern_source.set_extern_path(&out_dir, extern_source_id);
+ // NOTE: cargo and rustc seem to hide non-UTF-8 strings from env! and option_env!()
+ if let Some(out_dir) = out_dir.to_str().map(|s| s.to_owned()) {
+ env.set("OUT_DIR", out_dir);
}
}
let proc_macro = cargo[pkg]
Some(CrateName::normalize_dashes(&cargo[pkg].name)),
cfg_options,
env,
- extern_source,
proc_macro.clone(),
);
if cargo[tgt].kind == TargetKind::Lib {
ProjectWorkspace::Cargo { cargo, .. } => {
Some(cargo.workspace_root()).filter(|root| path.starts_with(root))
}
- ProjectWorkspace::Json { project: JsonProject { roots, .. } } => roots
+ ProjectWorkspace::Json { project: ProjectJson { 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_in_parent_dir(path: &Path) -> Option<PathBuf> {
- let mut curr = Some(path);
- while let Some(path) = curr {
- let candidate = path.join("Cargo.toml");
- if candidate.exists() {
- return Some(candidate);
- }
- curr = path.parent();
- }
-
- None
-}
-
-fn find_cargo_toml_in_child_dir(entities: ReadDir) -> Vec<PathBuf> {
- // Only one level down to avoid cycles the easy way and stop a runaway scan with large projects
- let mut valid_canditates = vec![];
- for entity in entities.filter_map(Result::ok) {
- let candidate = entity.path().join("Cargo.toml");
- if candidate.exists() {
- valid_canditates.push(candidate)
- }
- }
- valid_canditates
-}
-
-fn find_cargo_toml(path: &Path) -> Result<PathBuf> {
- if path.ends_with("Cargo.toml") {
- return Ok(path.to_path_buf());
- }
-
- if let Some(p) = find_cargo_toml_in_parent_dir(path) {
- return Ok(p);
- }
-
- let entities = match read_dir(path) {
- Ok(entities) => entities,
- Err(e) => {
- return Err(CargoTomlNotFoundError {
- searched_at: path.to_path_buf(),
- reason: format!("file system error: {}", e),
- }
- .into());
- }
- };
-
- let mut valid_canditates = find_cargo_toml_in_child_dir(entities);
- match valid_canditates.len() {
- 1 => Ok(valid_canditates.remove(0)),
- 0 => Err(CargoTomlNotFoundError {
- searched_at: path.to_path_buf(),
- reason: "no Cargo.toml file found".to_string(),
- }
- .into()),
- _ => Err(CargoTomlNotFoundError {
- searched_at: path.to_path_buf(),
- reason: format!(
- "multiple equally valid Cargo.toml files found: {:?}",
- valid_canditates
- ),
- }
- .into()),
- }
-}
-
-pub fn get_rustc_cfg_options() -> CfgOptions {
+fn get_rustc_cfg_options(target: Option<&str>) -> CfgOptions {
let mut cfg_options = CfgOptions::default();
// Some nightly-only cfgs, which are required for stdlib
}
}
- match (|| -> Result<String> {
+ let rustc_cfgs = || -> Result<String> {
// `cfg(test)` and `cfg(debug_assertion)` are handled outside, so we suppress them here.
- let output = Command::new("rustc")
- .args(&["--print", "cfg", "-O"])
- .output()
- .context("Failed to get output from rustc --print cfg -O")?;
- if !output.status.success() {
- bail!(
- "rustc --print cfg -O exited with exit code ({})",
- output
- .status
- .code()
- .map_or(String::from("no exit code"), |code| format!("{}", code))
- );
+ let mut cmd = Command::new(ra_toolchain::rustc());
+ cmd.args(&["--print", "cfg", "-O"]);
+ if let Some(target) = target {
+ cmd.args(&["--target", target]);
}
+ let output = output(cmd)?;
Ok(String::from_utf8(output.stdout)?)
- })() {
+ }();
+
+ match rustc_cfgs {
Ok(rustc_cfgs) => {
for line in rustc_cfgs.lines() {
match line.find('=') {
}
}
}
- Err(e) => log::error!("failed to get rustc cfgs: {}", e),
+ Err(e) => log::error!("failed to get rustc cfgs: {:#}", e),
}
+ cfg_options.insert_atom("debug_assertions".into());
+
cfg_options
}
+
+fn output(mut cmd: Command) -> Result<Output> {
+ let output = cmd.output().with_context(|| format!("{:?} failed", cmd))?;
+ if !output.status.success() {
+ match String::from_utf8(output.stderr) {
+ Ok(stderr) if !stderr.is_empty() => {
+ bail!("{:?} failed, {}\nstderr:\n{}", cmd, output.status, stderr)
+ }
+ _ => bail!("{:?} failed, {}", cmd, output.status),
+ }
+ }
+ Ok(output)
+}
projects / rust.git / blobdiff