2019-09-30 03:58:53 -05:00
|
|
|
//! This module specifies the input to rust-analyzer. In some sense, this is
|
|
|
|
//! **the** most important module, because all other fancy stuff is strictly
|
|
|
|
//! derived from this input.
|
|
|
|
//!
|
|
|
|
//! Note that neither this module, nor any other part of the analyzer's core do
|
2020-02-18 05:33:16 -06:00
|
|
|
//! actual IO. See `vfs` and `project_model` in the `rust-analyzer` crate for how
|
2019-09-30 03:58:53 -05:00
|
|
|
//! actual IO is done and lowered to input.
|
|
|
|
|
2020-12-11 07:24:02 -06:00
|
|
|
use std::{fmt, iter::FromIterator, ops, panic::RefUnwindSafe, str::FromStr, sync::Arc};
|
2018-10-25 02:57:55 -05:00
|
|
|
|
2020-08-13 03:19:09 -05:00
|
|
|
use cfg::CfgOptions;
|
2020-06-11 04:30:06 -05:00
|
|
|
use rustc_hash::{FxHashMap, FxHashSet};
|
2020-08-12 11:26:51 -05:00
|
|
|
use syntax::SmolStr;
|
2020-12-11 07:24:02 -06:00
|
|
|
use tt::{ExpansionError, Subtree};
|
2020-11-02 06:13:32 -06:00
|
|
|
use vfs::{file_set::FileSet, FileId, VfsPath};
|
2018-10-25 09:52:50 -05:00
|
|
|
|
2018-12-20 04:47:32 -06:00
|
|
|
/// Files are grouped into source roots. A source root is a directory on the
|
|
|
|
/// file systems which is watched for changes. Typically it corresponds to a
|
2019-01-08 17:47:12 -06:00
|
|
|
/// Rust crate. Source roots *might* be nested: in this case, a file belongs to
|
|
|
|
/// the nearest enclosing source root. Paths to files are always relative to a
|
|
|
|
/// source root, and the analyzer does not know the root path of the source root at
|
|
|
|
/// all. So, a file from one source root can't refer to a file in another source
|
2018-12-20 04:47:32 -06:00
|
|
|
/// root by path.
|
|
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
|
|
|
|
pub struct SourceRootId(pub u32);
|
|
|
|
|
2020-01-08 12:29:18 -06:00
|
|
|
#[derive(Clone, Debug, PartialEq, Eq)]
|
2018-12-20 04:47:32 -06:00
|
|
|
pub struct SourceRoot {
|
2019-06-24 04:35:07 -05:00
|
|
|
/// Sysroot or crates.io library.
|
|
|
|
///
|
|
|
|
/// Libraries are considered mostly immutable, this assumption is used to
|
|
|
|
/// optimize salsa's query structure
|
|
|
|
pub is_library: bool,
|
2020-06-11 04:04:09 -05:00
|
|
|
pub(crate) file_set: FileSet,
|
2018-12-20 04:47:32 -06:00
|
|
|
}
|
2018-10-25 09:52:50 -05:00
|
|
|
|
2019-06-24 04:35:07 -05:00
|
|
|
impl SourceRoot {
|
2020-06-11 04:04:09 -05:00
|
|
|
pub fn new_local(file_set: FileSet) -> SourceRoot {
|
|
|
|
SourceRoot { is_library: false, file_set }
|
2019-09-05 14:36:04 -05:00
|
|
|
}
|
2020-06-11 04:04:09 -05:00
|
|
|
pub fn new_library(file_set: FileSet) -> SourceRoot {
|
|
|
|
SourceRoot { is_library: true, file_set }
|
2019-09-05 14:36:04 -05:00
|
|
|
}
|
2020-09-07 12:52:37 -05:00
|
|
|
pub fn path_for_file(&self, file: &FileId) -> Option<&VfsPath> {
|
|
|
|
self.file_set.path_for_file(file)
|
|
|
|
}
|
|
|
|
pub fn file_for_path(&self, path: &VfsPath) -> Option<&FileId> {
|
|
|
|
self.file_set.file_for_path(path)
|
|
|
|
}
|
2020-06-11 04:04:09 -05:00
|
|
|
pub fn iter(&self) -> impl Iterator<Item = FileId> + '_ {
|
|
|
|
self.file_set.iter()
|
2019-10-11 03:37:54 -05:00
|
|
|
}
|
2019-06-24 04:35:07 -05:00
|
|
|
}
|
|
|
|
|
2018-12-20 04:47:32 -06:00
|
|
|
/// `CrateGraph` is a bit of information which turns a set of text files into a
|
2021-05-24 17:56:19 -05:00
|
|
|
/// number of Rust crates.
|
|
|
|
///
|
|
|
|
/// Each crate is defined by the `FileId` of its root module, the set of enabled
|
|
|
|
/// `cfg` flags and the set of dependencies.
|
|
|
|
///
|
|
|
|
/// Note that, due to cfg's, there might be several crates for a single `FileId`!
|
|
|
|
///
|
|
|
|
/// For the purposes of analysis, a crate does not have a name. Instead, names
|
|
|
|
/// are specified on dependency edges. That is, a crate might be known under
|
2019-01-08 17:47:12 -06:00
|
|
|
/// different names in different dependent crates.
|
2018-12-20 04:47:32 -06:00
|
|
|
///
|
|
|
|
/// Note that `CrateGraph` is build-system agnostic: it's a concept of the Rust
|
2019-01-08 17:47:12 -06:00
|
|
|
/// language proper, not a concept of the build system. In practice, we get
|
2018-12-20 04:47:32 -06:00
|
|
|
/// `CrateGraph` by lowering `cargo metadata` output.
|
2021-07-01 06:10:57 -05:00
|
|
|
#[derive(Debug, Clone, Default)]
|
2018-10-25 09:52:50 -05:00
|
|
|
pub struct CrateGraph {
|
2018-12-05 07:01:18 -06:00
|
|
|
arena: FxHashMap<CrateId, CrateData>,
|
2018-10-25 09:52:50 -05:00
|
|
|
}
|
|
|
|
|
2018-12-20 04:47:32 -06:00
|
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
|
|
|
pub struct CrateId(pub u32);
|
|
|
|
|
2020-07-01 03:03:07 -05:00
|
|
|
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
|
2020-02-05 03:53:54 -06:00
|
|
|
pub struct CrateName(SmolStr);
|
|
|
|
|
2020-02-05 04:47:28 -06:00
|
|
|
impl CrateName {
|
2020-03-08 08:26:57 -05:00
|
|
|
/// Creates a crate name, checking for dashes in the string provided.
|
2020-02-05 04:47:28 -06:00
|
|
|
/// Dashes are not allowed in the crate names,
|
|
|
|
/// hence the input string is returned as `Err` for those cases.
|
|
|
|
pub fn new(name: &str) -> Result<CrateName, &str> {
|
|
|
|
if name.contains('-') {
|
|
|
|
Err(name)
|
|
|
|
} else {
|
|
|
|
Ok(Self(SmolStr::new(name)))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-03-08 08:26:57 -05:00
|
|
|
/// Creates a crate name, unconditionally replacing the dashes with underscores.
|
2020-02-05 04:47:28 -06:00
|
|
|
pub fn normalize_dashes(name: &str) -> CrateName {
|
|
|
|
Self(SmolStr::new(name.replace('-', "_")))
|
2020-02-05 03:53:54 -06:00
|
|
|
}
|
2020-03-16 05:03:43 -05:00
|
|
|
}
|
2020-03-16 04:47:52 -05:00
|
|
|
|
2020-06-11 04:30:06 -05:00
|
|
|
impl fmt::Display for CrateName {
|
2020-03-16 05:03:43 -05:00
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
|
|
write!(f, "{}", self.0)
|
2020-03-16 04:47:52 -05:00
|
|
|
}
|
2020-02-05 03:53:54 -06:00
|
|
|
}
|
|
|
|
|
2020-07-01 02:53:53 -05:00
|
|
|
impl ops::Deref for CrateName {
|
|
|
|
type Target = str;
|
2020-10-20 09:00:51 -05:00
|
|
|
fn deref(&self) -> &str {
|
|
|
|
&*self.0
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
|
2020-10-20 10:04:38 -05:00
|
|
|
pub struct CrateDisplayName {
|
|
|
|
// The name we use to display various paths (with `_`).
|
|
|
|
crate_name: CrateName,
|
|
|
|
// The name as specified in Cargo.toml (with `-`).
|
|
|
|
canonical_name: String,
|
|
|
|
}
|
2020-10-20 09:00:51 -05:00
|
|
|
|
|
|
|
impl From<CrateName> for CrateDisplayName {
|
2020-10-20 10:04:38 -05:00
|
|
|
fn from(crate_name: CrateName) -> CrateDisplayName {
|
|
|
|
let canonical_name = crate_name.to_string();
|
|
|
|
CrateDisplayName { crate_name, canonical_name }
|
2020-10-20 09:00:51 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl fmt::Display for CrateDisplayName {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
2020-10-20 10:04:38 -05:00
|
|
|
write!(f, "{}", self.crate_name)
|
2020-10-20 09:00:51 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl ops::Deref for CrateDisplayName {
|
|
|
|
type Target = str;
|
|
|
|
fn deref(&self) -> &str {
|
2020-10-20 10:04:38 -05:00
|
|
|
&*self.crate_name
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl CrateDisplayName {
|
|
|
|
pub fn from_canonical_name(canonical_name: String) -> CrateDisplayName {
|
|
|
|
let crate_name = CrateName::normalize_dashes(&canonical_name);
|
|
|
|
CrateDisplayName { crate_name, canonical_name }
|
2020-07-01 02:53:53 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-03-18 07:56:46 -05:00
|
|
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
|
2020-03-26 11:41:44 -05:00
|
|
|
pub struct ProcMacroId(pub u32);
|
|
|
|
|
2021-05-29 13:32:57 -05:00
|
|
|
#[derive(Copy, Clone, Eq, PartialEq, Debug, Hash)]
|
2020-12-07 10:06:14 -06:00
|
|
|
pub enum ProcMacroKind {
|
|
|
|
CustomDerive,
|
|
|
|
FuncLike,
|
|
|
|
Attr,
|
|
|
|
}
|
|
|
|
|
2020-12-11 07:24:02 -06:00
|
|
|
pub trait ProcMacroExpander: fmt::Debug + Send + Sync + RefUnwindSafe {
|
2020-12-11 07:57:50 -06:00
|
|
|
fn expand(
|
|
|
|
&self,
|
|
|
|
subtree: &Subtree,
|
|
|
|
attrs: Option<&Subtree>,
|
|
|
|
env: &Env,
|
|
|
|
) -> Result<Subtree, ExpansionError>;
|
2020-12-11 07:24:02 -06:00
|
|
|
}
|
|
|
|
|
2020-03-26 11:41:44 -05:00
|
|
|
#[derive(Debug, Clone)]
|
|
|
|
pub struct ProcMacro {
|
|
|
|
pub name: SmolStr,
|
2020-12-07 10:06:14 -06:00
|
|
|
pub kind: ProcMacroKind,
|
2020-12-11 07:24:02 -06:00
|
|
|
pub expander: Arc<dyn ProcMacroExpander>,
|
2020-03-26 11:41:44 -05:00
|
|
|
}
|
|
|
|
|
2021-07-01 06:10:57 -05:00
|
|
|
#[derive(Debug, Clone)]
|
2020-03-09 04:26:46 -05:00
|
|
|
pub struct CrateData {
|
|
|
|
pub root_file_id: FileId,
|
|
|
|
pub edition: Edition,
|
2020-10-20 08:38:11 -05:00
|
|
|
/// A name used in the package's project declaration: for Cargo projects,
|
2021-01-18 15:44:40 -06:00
|
|
|
/// its `[package].name` can be different for other project types or even
|
2020-10-20 08:38:11 -05:00
|
|
|
/// absent (a dummy crate for the code snippet, for example).
|
|
|
|
///
|
|
|
|
/// For purposes of analysis, crates are anonymous (only names in
|
|
|
|
/// `Dependency` matters), this name should only be used for UI.
|
2020-10-20 10:04:38 -05:00
|
|
|
pub display_name: Option<CrateDisplayName>,
|
2020-03-09 05:14:51 -05:00
|
|
|
pub cfg_options: CfgOptions,
|
2021-05-31 14:45:01 -05:00
|
|
|
pub potential_cfg_options: CfgOptions,
|
2020-03-09 05:14:51 -05:00
|
|
|
pub env: Env,
|
2020-03-09 04:26:46 -05:00
|
|
|
pub dependencies: Vec<Dependency>,
|
2020-03-18 07:56:46 -05:00
|
|
|
pub proc_macro: Vec<ProcMacro>,
|
2019-09-08 01:48:45 -05:00
|
|
|
}
|
|
|
|
|
2021-01-01 10:22:23 -06:00
|
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
2019-02-10 15:34:29 -06:00
|
|
|
pub enum Edition {
|
|
|
|
Edition2015,
|
2021-01-01 10:22:23 -06:00
|
|
|
Edition2018,
|
|
|
|
Edition2021,
|
2019-02-10 15:34:29 -06:00
|
|
|
}
|
|
|
|
|
2019-11-22 04:55:03 -06:00
|
|
|
#[derive(Default, Debug, Clone, PartialEq, Eq)]
|
|
|
|
pub struct Env {
|
|
|
|
entries: FxHashMap<String, String>,
|
2020-03-10 22:04:02 -05:00
|
|
|
}
|
2020-03-10 08:59:12 -05:00
|
|
|
|
2018-12-05 07:01:18 -06:00
|
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
|
|
pub struct Dependency {
|
2018-12-08 16:05:49 -06:00
|
|
|
pub crate_id: CrateId,
|
2020-07-01 02:53:53 -05:00
|
|
|
pub name: CrateName,
|
2018-12-08 15:51:06 -06:00
|
|
|
}
|
|
|
|
|
2018-12-05 07:01:18 -06:00
|
|
|
impl CrateGraph {
|
2019-09-29 18:38:16 -05:00
|
|
|
pub fn add_crate_root(
|
|
|
|
&mut self,
|
|
|
|
file_id: FileId,
|
|
|
|
edition: Edition,
|
2020-10-20 10:04:38 -05:00
|
|
|
display_name: Option<CrateDisplayName>,
|
2019-09-29 18:38:16 -05:00
|
|
|
cfg_options: CfgOptions,
|
2021-05-31 14:45:01 -05:00
|
|
|
potential_cfg_options: CfgOptions,
|
2019-11-22 04:55:03 -06:00
|
|
|
env: Env,
|
2020-12-07 10:06:14 -06:00
|
|
|
proc_macro: Vec<ProcMacro>,
|
2019-09-29 18:38:16 -05:00
|
|
|
) -> CrateId {
|
2020-03-09 05:17:39 -05:00
|
|
|
let data = CrateData {
|
|
|
|
root_file_id: file_id,
|
|
|
|
edition,
|
2020-10-20 08:38:11 -05:00
|
|
|
display_name,
|
2020-03-09 05:17:39 -05:00
|
|
|
cfg_options,
|
2021-05-31 14:45:01 -05:00
|
|
|
potential_cfg_options,
|
2020-03-09 05:17:39 -05:00
|
|
|
env,
|
2020-03-18 07:56:46 -05:00
|
|
|
proc_macro,
|
2020-03-09 05:17:39 -05:00
|
|
|
dependencies: Vec::new(),
|
|
|
|
};
|
2018-12-05 07:01:18 -06:00
|
|
|
let crate_id = CrateId(self.arena.len() as u32);
|
2019-11-22 04:55:03 -06:00
|
|
|
let prev = self.arena.insert(crate_id, data);
|
2018-10-25 09:52:50 -05:00
|
|
|
assert!(prev.is_none());
|
|
|
|
crate_id
|
|
|
|
}
|
2019-02-06 15:54:33 -06:00
|
|
|
|
2019-01-13 03:27:26 -06:00
|
|
|
pub fn add_dep(
|
|
|
|
&mut self,
|
|
|
|
from: CrateId,
|
2020-02-05 03:53:54 -06:00
|
|
|
name: CrateName,
|
2019-01-13 03:27:26 -06:00
|
|
|
to: CrateId,
|
2019-11-22 05:12:45 -06:00
|
|
|
) -> Result<(), CyclicDependenciesError> {
|
2021-04-22 13:48:17 -05:00
|
|
|
let _p = profile::span("add_dep");
|
2019-01-13 03:27:26 -06:00
|
|
|
if self.dfs_find(from, to, &mut FxHashSet::default()) {
|
2020-11-17 04:50:54 -06:00
|
|
|
return Err(CyclicDependenciesError {
|
|
|
|
from: (from, self[from].display_name.clone()),
|
|
|
|
to: (to, self[to].display_name.clone()),
|
|
|
|
});
|
2018-12-21 08:27:04 -06:00
|
|
|
}
|
2020-07-01 02:53:53 -05:00
|
|
|
self.arena.get_mut(&from).unwrap().add_dep(name, to);
|
2019-07-04 21:59:28 -05:00
|
|
|
Ok(())
|
2018-12-05 07:01:18 -06:00
|
|
|
}
|
2019-02-06 15:54:33 -06:00
|
|
|
|
2018-12-21 10:13:26 -06:00
|
|
|
pub fn is_empty(&self) -> bool {
|
|
|
|
self.arena.is_empty()
|
|
|
|
}
|
2019-02-06 15:54:33 -06:00
|
|
|
|
2020-02-22 09:00:39 -06:00
|
|
|
pub fn iter(&self) -> impl Iterator<Item = CrateId> + '_ {
|
2019-07-04 12:26:44 -05:00
|
|
|
self.arena.keys().copied()
|
2019-03-02 14:59:04 -06:00
|
|
|
}
|
|
|
|
|
2021-03-23 04:58:48 -05:00
|
|
|
/// Returns an iterator over all transitive dependencies of the given crate,
|
|
|
|
/// including the crate itself.
|
2020-07-01 08:18:51 -05:00
|
|
|
pub fn transitive_deps(&self, of: CrateId) -> impl Iterator<Item = CrateId> + '_ {
|
|
|
|
let mut worklist = vec![of];
|
|
|
|
let mut deps = FxHashSet::default();
|
|
|
|
|
|
|
|
while let Some(krate) = worklist.pop() {
|
|
|
|
if !deps.insert(krate) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
worklist.extend(self[krate].dependencies.iter().map(|dep| dep.crate_id));
|
|
|
|
}
|
|
|
|
|
|
|
|
deps.into_iter()
|
|
|
|
}
|
|
|
|
|
2021-03-23 04:49:55 -05:00
|
|
|
/// Returns all transitive reverse dependencies of the given crate,
|
|
|
|
/// including the crate itself.
|
2021-03-23 04:59:51 -05:00
|
|
|
pub fn transitive_rev_deps(&self, of: CrateId) -> impl Iterator<Item = CrateId> + '_ {
|
2021-03-15 11:43:46 -05:00
|
|
|
let mut worklist = vec![of];
|
|
|
|
let mut rev_deps = FxHashSet::default();
|
2021-03-23 04:49:55 -05:00
|
|
|
rev_deps.insert(of);
|
2021-03-23 05:01:45 -05:00
|
|
|
|
2021-03-16 09:53:34 -05:00
|
|
|
let mut inverted_graph = FxHashMap::<_, Vec<_>>::default();
|
2021-03-15 11:43:46 -05:00
|
|
|
self.arena.iter().for_each(|(&krate, data)| {
|
2021-03-16 09:53:34 -05:00
|
|
|
data.dependencies
|
|
|
|
.iter()
|
|
|
|
.for_each(|dep| inverted_graph.entry(dep.crate_id).or_default().push(krate))
|
2021-03-15 11:43:46 -05:00
|
|
|
});
|
|
|
|
|
|
|
|
while let Some(krate) = worklist.pop() {
|
2021-03-16 09:53:34 -05:00
|
|
|
if let Some(krate_rev_deps) = inverted_graph.get(&krate) {
|
|
|
|
krate_rev_deps
|
|
|
|
.iter()
|
|
|
|
.copied()
|
|
|
|
.filter(|&rev_dep| rev_deps.insert(rev_dep))
|
|
|
|
.for_each(|rev_dep| worklist.push(rev_dep));
|
2021-03-15 11:43:46 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
rev_deps.into_iter()
|
|
|
|
}
|
|
|
|
|
2020-10-06 10:58:03 -05:00
|
|
|
/// Returns all crates in the graph, sorted in topological order (ie. dependencies of a crate
|
|
|
|
/// come before the crate itself).
|
|
|
|
pub fn crates_in_topological_order(&self) -> Vec<CrateId> {
|
|
|
|
let mut res = Vec::new();
|
|
|
|
let mut visited = FxHashSet::default();
|
|
|
|
|
|
|
|
for krate in self.arena.keys().copied() {
|
|
|
|
go(self, &mut visited, &mut res, krate);
|
|
|
|
}
|
|
|
|
|
|
|
|
return res;
|
|
|
|
|
|
|
|
fn go(
|
|
|
|
graph: &CrateGraph,
|
|
|
|
visited: &mut FxHashSet<CrateId>,
|
|
|
|
res: &mut Vec<CrateId>,
|
|
|
|
source: CrateId,
|
|
|
|
) {
|
|
|
|
if !visited.insert(source) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
for dep in graph[source].dependencies.iter() {
|
|
|
|
go(graph, visited, res, dep.crate_id)
|
|
|
|
}
|
|
|
|
res.push(source)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-03-23 02:53:48 -05:00
|
|
|
// FIXME: this only finds one crate with the given root; we could have multiple
|
2018-11-27 18:25:20 -06:00
|
|
|
pub fn crate_id_for_crate_root(&self, file_id: FileId) -> Option<CrateId> {
|
2020-03-09 04:26:46 -05:00
|
|
|
let (&crate_id, _) =
|
|
|
|
self.arena.iter().find(|(_crate_id, data)| data.root_file_id == file_id)?;
|
2018-11-27 18:25:20 -06:00
|
|
|
Some(crate_id)
|
2018-11-26 15:12:43 -06:00
|
|
|
}
|
2019-02-06 15:54:33 -06:00
|
|
|
|
|
|
|
/// Extends this crate graph by adding a complete disjoint second crate
|
|
|
|
/// graph.
|
2019-09-08 01:48:45 -05:00
|
|
|
///
|
|
|
|
/// The ids of the crates in the `other` graph are shifted by the return
|
|
|
|
/// amount.
|
|
|
|
pub fn extend(&mut self, other: CrateGraph) -> u32 {
|
2019-02-06 15:54:33 -06:00
|
|
|
let start = self.arena.len() as u32;
|
|
|
|
self.arena.extend(other.arena.into_iter().map(|(id, mut data)| {
|
2019-09-08 01:48:45 -05:00
|
|
|
let new_id = id.shift(start);
|
2019-02-06 15:54:33 -06:00
|
|
|
for dep in &mut data.dependencies {
|
2019-09-08 01:48:45 -05:00
|
|
|
dep.crate_id = dep.crate_id.shift(start);
|
2019-02-06 15:54:33 -06:00
|
|
|
}
|
|
|
|
(new_id, data)
|
|
|
|
}));
|
2019-09-08 01:48:45 -05:00
|
|
|
start
|
2019-02-06 15:54:33 -06:00
|
|
|
}
|
|
|
|
|
2018-12-22 01:30:58 -06:00
|
|
|
fn dfs_find(&self, target: CrateId, from: CrateId, visited: &mut FxHashSet<CrateId>) -> bool {
|
2018-12-22 08:40:41 -06:00
|
|
|
if !visited.insert(from) {
|
2018-12-22 01:30:58 -06:00
|
|
|
return false;
|
|
|
|
}
|
2018-12-22 08:40:41 -06:00
|
|
|
|
2020-06-19 11:02:54 -05:00
|
|
|
if target == from {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2020-03-09 05:11:59 -05:00
|
|
|
for dep in &self[from].dependencies {
|
2020-03-09 05:18:41 -05:00
|
|
|
let crate_id = dep.crate_id;
|
2018-12-22 01:30:58 -06:00
|
|
|
if self.dfs_find(target, crate_id, visited) {
|
|
|
|
return true;
|
2018-12-21 08:27:04 -06:00
|
|
|
}
|
|
|
|
}
|
2019-07-04 12:26:44 -05:00
|
|
|
false
|
2018-12-21 08:27:04 -06:00
|
|
|
}
|
2020-10-20 05:34:39 -05:00
|
|
|
|
|
|
|
// Work around for https://github.com/rust-analyzer/rust-analyzer/issues/6038.
|
|
|
|
// As hacky as it gets.
|
|
|
|
pub fn patch_cfg_if(&mut self) -> bool {
|
|
|
|
let cfg_if = self.hacky_find_crate("cfg_if");
|
|
|
|
let std = self.hacky_find_crate("std");
|
|
|
|
match (cfg_if, std) {
|
|
|
|
(Some(cfg_if), Some(std)) => {
|
|
|
|
self.arena.get_mut(&cfg_if).unwrap().dependencies.clear();
|
|
|
|
self.arena
|
|
|
|
.get_mut(&std)
|
|
|
|
.unwrap()
|
|
|
|
.dependencies
|
|
|
|
.push(Dependency { crate_id: cfg_if, name: CrateName::new("cfg_if").unwrap() });
|
|
|
|
true
|
|
|
|
}
|
|
|
|
_ => false,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-10-20 08:38:11 -05:00
|
|
|
fn hacky_find_crate(&self, display_name: &str) -> Option<CrateId> {
|
|
|
|
self.iter().find(|it| self[*it].display_name.as_deref() == Some(display_name))
|
2020-10-20 05:34:39 -05:00
|
|
|
}
|
2018-10-25 09:52:50 -05:00
|
|
|
}
|
2018-10-25 02:57:55 -05:00
|
|
|
|
2020-03-09 05:11:59 -05:00
|
|
|
impl ops::Index<CrateId> for CrateGraph {
|
|
|
|
type Output = CrateData;
|
|
|
|
fn index(&self, crate_id: CrateId) -> &CrateData {
|
|
|
|
&self.arena[&crate_id]
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-11-22 05:12:45 -06:00
|
|
|
impl CrateId {
|
|
|
|
pub fn shift(self, amount: u32) -> CrateId {
|
|
|
|
CrateId(self.0 + amount)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl CrateData {
|
2020-07-01 02:53:53 -05:00
|
|
|
fn add_dep(&mut self, name: CrateName, crate_id: CrateId) {
|
2021-03-21 09:33:18 -05:00
|
|
|
self.dependencies.push(Dependency { crate_id, name })
|
2019-11-22 05:12:45 -06:00
|
|
|
}
|
2019-11-22 05:08:18 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
impl FromStr for Edition {
|
|
|
|
type Err = ParseEditionError;
|
|
|
|
|
|
|
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
|
|
|
let res = match s {
|
|
|
|
"2015" => Edition::Edition2015,
|
|
|
|
"2018" => Edition::Edition2018,
|
2021-01-01 10:22:23 -06:00
|
|
|
"2021" => Edition::Edition2021,
|
2020-02-18 06:53:02 -06:00
|
|
|
_ => return Err(ParseEditionError { invalid_input: s.to_string() }),
|
2019-11-22 05:08:18 -06:00
|
|
|
};
|
|
|
|
Ok(res)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-12-04 16:05:01 -06:00
|
|
|
impl fmt::Display for Edition {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
|
|
f.write_str(match self {
|
|
|
|
Edition::Edition2015 => "2015",
|
|
|
|
Edition::Edition2018 => "2018",
|
2021-01-01 10:22:23 -06:00
|
|
|
Edition::Edition2021 => "2021",
|
2019-12-04 16:05:01 -06:00
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-07-21 10:17:21 -05:00
|
|
|
impl FromIterator<(String, String)> for Env {
|
|
|
|
fn from_iter<T: IntoIterator<Item = (String, String)>>(iter: T) -> Self {
|
|
|
|
Env { entries: FromIterator::from_iter(iter) }
|
2020-05-16 07:23:43 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-03-09 13:02:43 -05:00
|
|
|
impl Env {
|
|
|
|
pub fn set(&mut self, env: &str, value: String) {
|
|
|
|
self.entries.insert(env.to_owned(), value);
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn get(&self, env: &str) -> Option<String> {
|
|
|
|
self.entries.get(env).cloned()
|
|
|
|
}
|
2020-12-11 07:57:50 -06:00
|
|
|
|
|
|
|
pub fn iter(&self) -> impl Iterator<Item = (&str, &str)> {
|
|
|
|
self.entries.iter().map(|(k, v)| (k.as_str(), v.as_str()))
|
|
|
|
}
|
2020-03-10 22:04:02 -05:00
|
|
|
}
|
2020-03-10 08:59:12 -05:00
|
|
|
|
2019-11-22 05:12:45 -06:00
|
|
|
#[derive(Debug)]
|
|
|
|
pub struct ParseEditionError {
|
|
|
|
invalid_input: String,
|
|
|
|
}
|
|
|
|
|
2019-11-22 05:08:18 -06:00
|
|
|
impl fmt::Display for ParseEditionError {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
|
|
write!(f, "invalid edition: {:?}", self.invalid_input)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl std::error::Error for ParseEditionError {}
|
|
|
|
|
2019-11-22 05:12:45 -06:00
|
|
|
#[derive(Debug)]
|
2020-11-17 04:50:54 -06:00
|
|
|
pub struct CyclicDependenciesError {
|
|
|
|
from: (CrateId, Option<CrateDisplayName>),
|
|
|
|
to: (CrateId, Option<CrateDisplayName>),
|
|
|
|
}
|
|
|
|
|
|
|
|
impl fmt::Display for CyclicDependenciesError {
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
|
|
let render = |(id, name): &(CrateId, Option<CrateDisplayName>)| match name {
|
|
|
|
Some(it) => format!("{}({:?})", it, id),
|
|
|
|
None => format!("{:?}", id),
|
|
|
|
};
|
|
|
|
write!(f, "cyclic deps: {} -> {}", render(&self.from), render(&self.to))
|
|
|
|
}
|
|
|
|
}
|
2019-11-22 05:12:45 -06:00
|
|
|
|
2019-01-13 03:27:26 -06:00
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
2020-02-05 04:47:28 -06:00
|
|
|
use super::{CfgOptions, CrateGraph, CrateName, Dependency, Edition::Edition2018, Env, FileId};
|
2019-01-13 03:27:26 -06:00
|
|
|
|
|
|
|
#[test]
|
2020-06-19 11:02:54 -05:00
|
|
|
fn detect_cyclic_dependency_indirect() {
|
2019-01-13 03:27:26 -06:00
|
|
|
let mut graph = CrateGraph::default();
|
2020-03-08 08:26:57 -05:00
|
|
|
let crate1 = graph.add_crate_root(
|
|
|
|
FileId(1u32),
|
|
|
|
Edition2018,
|
|
|
|
None,
|
|
|
|
CfgOptions::default(),
|
2021-05-31 14:45:01 -05:00
|
|
|
CfgOptions::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
Env::default(),
|
2020-03-10 22:04:02 -05:00
|
|
|
Default::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
);
|
|
|
|
let crate2 = graph.add_crate_root(
|
|
|
|
FileId(2u32),
|
|
|
|
Edition2018,
|
|
|
|
None,
|
|
|
|
CfgOptions::default(),
|
2021-05-31 14:45:01 -05:00
|
|
|
CfgOptions::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
Env::default(),
|
2020-03-10 22:04:02 -05:00
|
|
|
Default::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
);
|
|
|
|
let crate3 = graph.add_crate_root(
|
|
|
|
FileId(3u32),
|
|
|
|
Edition2018,
|
|
|
|
None,
|
|
|
|
CfgOptions::default(),
|
2021-05-31 14:45:01 -05:00
|
|
|
CfgOptions::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
Env::default(),
|
2020-03-10 22:04:02 -05:00
|
|
|
Default::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
);
|
2020-02-05 04:47:28 -06:00
|
|
|
assert!(graph.add_dep(crate1, CrateName::new("crate2").unwrap(), crate2).is_ok());
|
|
|
|
assert!(graph.add_dep(crate2, CrateName::new("crate3").unwrap(), crate3).is_ok());
|
|
|
|
assert!(graph.add_dep(crate3, CrateName::new("crate1").unwrap(), crate1).is_err());
|
2019-01-13 03:27:26 -06:00
|
|
|
}
|
|
|
|
|
2020-06-19 11:02:54 -05:00
|
|
|
#[test]
|
|
|
|
fn detect_cyclic_dependency_direct() {
|
|
|
|
let mut graph = CrateGraph::default();
|
|
|
|
let crate1 = graph.add_crate_root(
|
|
|
|
FileId(1u32),
|
|
|
|
Edition2018,
|
|
|
|
None,
|
|
|
|
CfgOptions::default(),
|
2021-05-31 14:45:01 -05:00
|
|
|
CfgOptions::default(),
|
2020-06-19 11:02:54 -05:00
|
|
|
Env::default(),
|
|
|
|
Default::default(),
|
|
|
|
);
|
|
|
|
let crate2 = graph.add_crate_root(
|
|
|
|
FileId(2u32),
|
|
|
|
Edition2018,
|
|
|
|
None,
|
|
|
|
CfgOptions::default(),
|
2021-05-31 14:45:01 -05:00
|
|
|
CfgOptions::default(),
|
2020-06-19 11:02:54 -05:00
|
|
|
Env::default(),
|
|
|
|
Default::default(),
|
|
|
|
);
|
|
|
|
assert!(graph.add_dep(crate1, CrateName::new("crate2").unwrap(), crate2).is_ok());
|
|
|
|
assert!(graph.add_dep(crate2, CrateName::new("crate2").unwrap(), crate2).is_err());
|
|
|
|
}
|
|
|
|
|
2019-01-13 03:27:26 -06:00
|
|
|
#[test]
|
|
|
|
fn it_works() {
|
|
|
|
let mut graph = CrateGraph::default();
|
2020-03-08 08:26:57 -05:00
|
|
|
let crate1 = graph.add_crate_root(
|
|
|
|
FileId(1u32),
|
|
|
|
Edition2018,
|
|
|
|
None,
|
|
|
|
CfgOptions::default(),
|
2021-05-31 14:45:01 -05:00
|
|
|
CfgOptions::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
Env::default(),
|
2020-03-10 22:04:02 -05:00
|
|
|
Default::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
);
|
|
|
|
let crate2 = graph.add_crate_root(
|
|
|
|
FileId(2u32),
|
|
|
|
Edition2018,
|
|
|
|
None,
|
|
|
|
CfgOptions::default(),
|
2021-05-31 14:45:01 -05:00
|
|
|
CfgOptions::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
Env::default(),
|
2020-03-10 22:04:02 -05:00
|
|
|
Default::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
);
|
|
|
|
let crate3 = graph.add_crate_root(
|
|
|
|
FileId(3u32),
|
|
|
|
Edition2018,
|
|
|
|
None,
|
|
|
|
CfgOptions::default(),
|
2021-05-31 14:45:01 -05:00
|
|
|
CfgOptions::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
Env::default(),
|
2020-03-10 22:04:02 -05:00
|
|
|
Default::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
);
|
2020-02-05 04:47:28 -06:00
|
|
|
assert!(graph.add_dep(crate1, CrateName::new("crate2").unwrap(), crate2).is_ok());
|
|
|
|
assert!(graph.add_dep(crate2, CrateName::new("crate3").unwrap(), crate3).is_ok());
|
2020-02-05 03:53:54 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn dashes_are_normalized() {
|
|
|
|
let mut graph = CrateGraph::default();
|
2020-03-08 08:26:57 -05:00
|
|
|
let crate1 = graph.add_crate_root(
|
|
|
|
FileId(1u32),
|
|
|
|
Edition2018,
|
|
|
|
None,
|
|
|
|
CfgOptions::default(),
|
2021-05-31 14:45:01 -05:00
|
|
|
CfgOptions::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
Env::default(),
|
2020-03-10 22:04:02 -05:00
|
|
|
Default::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
);
|
|
|
|
let crate2 = graph.add_crate_root(
|
|
|
|
FileId(2u32),
|
|
|
|
Edition2018,
|
|
|
|
None,
|
|
|
|
CfgOptions::default(),
|
2021-05-31 14:45:01 -05:00
|
|
|
CfgOptions::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
Env::default(),
|
2020-03-10 22:04:02 -05:00
|
|
|
Default::default(),
|
2020-03-08 08:26:57 -05:00
|
|
|
);
|
2020-02-05 04:47:28 -06:00
|
|
|
assert!(graph
|
|
|
|
.add_dep(crate1, CrateName::normalize_dashes("crate-name-with-dashes"), crate2)
|
|
|
|
.is_ok());
|
2020-02-05 03:53:54 -06:00
|
|
|
assert_eq!(
|
2020-03-09 05:11:59 -05:00
|
|
|
graph[crate1].dependencies,
|
2020-07-01 02:53:53 -05:00
|
|
|
vec![Dependency {
|
|
|
|
crate_id: crate2,
|
|
|
|
name: CrateName::new("crate_name_with_dashes").unwrap()
|
|
|
|
}]
|
2020-02-05 03:53:54 -06:00
|
|
|
);
|
2019-01-13 03:27:26 -06:00
|
|
|
}
|
|
|
|
}
|