rust-analyzer/crates/base-db/src/input.rs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

864 lines
26 KiB
Rust
Raw Normal View History

//! 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 11:33:16 +00:00
//! actual IO. See `vfs` and `project_model` in the `rust-analyzer` crate for how
//! actual IO is done and lowered to input.
2024-03-19 15:53:34 +00:00
use std::{fmt, mem, ops};
2023-11-08 15:51:20 +00:00
use cfg::CfgOptions;
2024-07-16 10:05:16 +00:00
use intern::Symbol;
use la_arena::{Arena, Idx, RawIdx};
use rustc_hash::{FxHashMap, FxHashSet};
use span::{Edition, EditionedFileId};
2023-05-02 14:12:22 +00:00
use triomphe::Arc;
2023-03-25 17:06:06 +00:00
use vfs::{file_set::FileSet, AbsPathBuf, AnchoredPath, FileId, VfsPath};
2018-10-25 14:52:50 +00:00
pub type ProcMacroPaths = FxHashMap<CrateId, Result<(String, AbsPathBuf), String>>;
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct SourceRootId(pub u32);
2018-12-20 10:47:32 +00: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
/// 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 10:47:32 +00:00
/// root by path.
#[derive(Clone, Debug, PartialEq, Eq)]
2018-12-20 10:47:32 +00:00
pub struct SourceRoot {
/// Sysroot or crates.io library.
///
/// Libraries are considered mostly immutable, this assumption is used to
/// optimize salsa's query structure
pub is_library: bool,
file_set: FileSet,
2018-12-20 10:47:32 +00:00
}
2018-10-25 14:52:50 +00:00
impl SourceRoot {
2020-06-11 09:04:09 +00:00
pub fn new_local(file_set: FileSet) -> SourceRoot {
SourceRoot { is_library: false, file_set }
2019-09-05 19:36:04 +00:00
}
2020-06-11 09:04:09 +00:00
pub fn new_library(file_set: FileSet) -> SourceRoot {
SourceRoot { is_library: true, file_set }
2019-09-05 19:36:04 +00: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)
}
pub fn resolve_path(&self, path: AnchoredPath<'_>) -> Option<FileId> {
self.file_set.resolve_path(path)
}
2020-06-11 09:04:09 +00:00
pub fn iter(&self) -> impl Iterator<Item = FileId> + '_ {
self.file_set.iter()
2019-10-11 08:37:54 +00:00
}
}
2018-12-20 10:47:32 +00:00
/// `CrateGraph` is a bit of information which turns a set of text files into a
/// 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
/// different names in different dependent crates.
2018-12-20 10:47:32 +00:00
///
/// Note that `CrateGraph` is build-system agnostic: it's a concept of the Rust
/// language proper, not a concept of the build system. In practice, we get
2018-12-20 10:47:32 +00:00
/// `CrateGraph` by lowering `cargo metadata` output.
///
/// `CrateGraph` is `!Serialize` by design, see
2022-07-08 13:44:49 +00:00
/// <https://github.com/rust-lang/rust-analyzer/blob/master/docs/dev/architecture.md#serialization>
#[derive(Clone, Default)]
2018-10-25 14:52:50 +00:00
pub struct CrateGraph {
arena: Arena<CrateData>,
2018-10-25 14:52:50 +00:00
}
impl fmt::Debug for CrateGraph {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_map()
.entries(self.arena.iter().map(|(id, data)| (u32::from(id.into_raw()), data)))
.finish()
}
}
2018-12-20 10:47:32 +00:00
pub type CrateId = Idx<CrateData>;
2024-07-16 10:05:16 +00:00
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CrateName(Symbol);
2020-02-05 09:53:54 +00:00
2020-02-05 10:47:28 +00:00
impl CrateName {
2020-03-08 13:26:57 +00:00
/// Creates a crate name, checking for dashes in the string provided.
2020-02-05 10:47:28 +00: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 {
2024-07-16 10:05:16 +00:00
Ok(Self(Symbol::intern(name)))
2020-02-05 10:47:28 +00:00
}
}
2020-03-08 13:26:57 +00:00
/// Creates a crate name, unconditionally replacing the dashes with underscores.
2020-02-05 10:47:28 +00:00
pub fn normalize_dashes(name: &str) -> CrateName {
2024-07-16 10:05:16 +00:00
Self(Symbol::intern(&name.replace('-', "_")))
2020-02-05 09:53:54 +00:00
}
2024-07-16 10:05:16 +00:00
pub fn symbol(&self) -> &Symbol {
&self.0
}
2020-03-16 10:03:43 +00:00
}
2020-03-16 09:47:52 +00:00
2020-06-11 09:30:06 +00:00
impl fmt::Display for CrateName {
2022-07-20 13:02:08 +00:00
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2022-03-21 08:43:36 +00:00
self.0.fmt(f)
2020-03-16 09:47:52 +00:00
}
2020-02-05 09:53:54 +00:00
}
2020-07-01 07:53:53 +00:00
impl ops::Deref for CrateName {
type Target = str;
2020-10-20 14:00:51 +00:00
fn deref(&self) -> &str {
2024-07-16 10:05:16 +00:00
self.0.as_str()
2020-10-20 14:00:51 +00:00
}
}
/// Origin of the crates.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
2021-11-22 17:44:46 +00:00
pub enum CrateOrigin {
/// Crates that are from the rustc workspace.
2024-07-16 10:05:16 +00:00
Rustc { name: Symbol },
/// Crates that are workspace members.
2024-07-16 10:05:16 +00:00
Local { repo: Option<String>, name: Option<Symbol> },
2023-03-31 07:10:18 +00:00
/// Crates that are non member libraries.
2024-07-16 10:05:16 +00:00
Library { repo: Option<String>, name: Symbol },
2021-11-22 17:44:46 +00:00
/// Crates that are provided by the language, like std, core, proc-macro, ...
Lang(LangCrateOrigin),
2021-11-22 17:44:46 +00:00
}
2023-06-05 11:27:19 +00:00
impl CrateOrigin {
pub fn is_local(&self) -> bool {
matches!(self, CrateOrigin::Local { .. })
}
pub fn is_lib(&self) -> bool {
matches!(self, CrateOrigin::Library { .. })
}
pub fn is_lang(&self) -> bool {
matches!(self, CrateOrigin::Lang { .. })
}
2023-06-05 11:27:19 +00:00
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum LangCrateOrigin {
Alloc,
Core,
ProcMacro,
Std,
Test,
Other,
2021-11-22 17:44:46 +00:00
}
2022-04-10 10:42:16 +00:00
impl From<&str> for LangCrateOrigin {
fn from(s: &str) -> Self {
match s {
"alloc" => LangCrateOrigin::Alloc,
"core" => LangCrateOrigin::Core,
"proc-macro" | "proc_macro" => LangCrateOrigin::ProcMacro,
2022-04-10 10:42:16 +00:00
"std" => LangCrateOrigin::Std,
"test" => LangCrateOrigin::Test,
_ => LangCrateOrigin::Other,
}
}
}
impl fmt::Display for LangCrateOrigin {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let text = match self {
LangCrateOrigin::Alloc => "alloc",
LangCrateOrigin::Core => "core",
LangCrateOrigin::ProcMacro => "proc_macro",
LangCrateOrigin::Std => "std",
LangCrateOrigin::Test => "test",
LangCrateOrigin::Other => "other",
};
f.write_str(text)
}
}
2024-07-16 10:05:16 +00:00
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
2020-10-20 15:04:38 +00:00
pub struct CrateDisplayName {
// The name we use to display various paths (with `_`).
crate_name: CrateName,
// The name as specified in Cargo.toml (with `-`).
2024-07-16 10:05:16 +00:00
canonical_name: Symbol,
2020-10-20 15:04:38 +00:00
}
2020-10-20 14:00:51 +00:00
impl CrateDisplayName {
2024-07-16 10:05:16 +00:00
pub fn canonical_name(&self) -> &Symbol {
&self.canonical_name
}
pub fn crate_name(&self) -> &CrateName {
&self.crate_name
}
}
2020-10-20 14:00:51 +00:00
impl From<CrateName> for CrateDisplayName {
2020-10-20 15:04:38 +00:00
fn from(crate_name: CrateName) -> CrateDisplayName {
2024-07-16 10:05:16 +00:00
let canonical_name = crate_name.0.clone();
2020-10-20 15:04:38 +00:00
CrateDisplayName { crate_name, canonical_name }
2020-10-20 14:00:51 +00:00
}
}
impl fmt::Display for CrateDisplayName {
2022-07-20 13:02:08 +00:00
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2022-03-21 08:43:36 +00:00
self.crate_name.fmt(f)
2020-10-20 14:00:51 +00:00
}
}
impl ops::Deref for CrateDisplayName {
type Target = str;
fn deref(&self) -> &str {
&self.crate_name
2020-10-20 15:04:38 +00:00
}
}
impl CrateDisplayName {
2024-07-16 10:05:16 +00:00
pub fn from_canonical_name(canonical_name: &str) -> CrateDisplayName {
let crate_name = CrateName::normalize_dashes(canonical_name);
CrateDisplayName { crate_name, canonical_name: Symbol::intern(canonical_name) }
2020-07-01 07:53:53 +00:00
}
}
pub type TargetLayoutLoadResult = Result<Arc<str>, Arc<str>>;
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
2023-03-31 07:10:18 +00:00
pub enum ReleaseChannel {
Stable,
Beta,
Nightly,
}
impl ReleaseChannel {
pub fn as_str(self) -> &'static str {
match self {
ReleaseChannel::Stable => "stable",
ReleaseChannel::Beta => "beta",
ReleaseChannel::Nightly => "nightly",
}
}
#[allow(clippy::should_implement_trait)]
2023-03-31 07:10:18 +00:00
pub fn from_str(str: &str) -> Option<Self> {
Some(match str {
"" | "stable" => ReleaseChannel::Stable,
2023-03-31 07:10:18 +00:00
"nightly" => ReleaseChannel::Nightly,
_ if str.starts_with("beta") => ReleaseChannel::Beta,
2023-03-31 07:10:18 +00:00
_ => return None,
})
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
2020-03-09 09:26:46 +00:00
pub struct CrateData {
pub root_file_id: FileId,
pub edition: Edition,
pub version: Option<String>,
/// A name used in the package's project declaration: for Cargo projects,
Fix warnings when running `cargo doc --document-private-items` These were the warnings previously: ``` warning: could not parse code block as Rust code --> crates/stdx/src/lib.rs:137:9 | 137 | /// ∀ x in slice[..idx]: pred(x) | _________^ 138 | | /// && ∀ x in slice[idx..]: !pred(x) | |____^ | = note: error from rustc: unknown start of token: \u{2200} warning: 1 warning emitted warning: unresolved link to `package` --> crates/base_db/src/input.rs:181:15 | 181 | /// it's [package].name, can be different for other project types or even | ^^^^^^^ no item named `package` in scope | = note: `#[warn(broken_intra_doc_links)]` on by default = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` warning: unresolved link to `package` --> crates/base_db/src/input.rs:181:15 | 181 | /// it's [package].name, can be different for other project types or even | ^^^^^^^ no item named `package` in scope | = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` warning: 2 warnings emitted warning: unresolved link to `package` --> crates/base_db/src/input.rs:181:15 | 181 | /// it's [package].name, can be different for other project types or even | ^^^^^^^ no item named `package` in scope | = note: `#[warn(broken_intra_doc_links)]` on by default = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` warning: unresolved link to `package` --> crates/base_db/src/input.rs:181:15 | 181 | /// it's [package].name, can be different for other project types or even | ^^^^^^^ no item named `package` in scope | = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` warning: 2 warnings emitted ``` This does *not* fix the following warning, because it is actually rust code and rustdoc is being over eager: ``` warning: Rust code block is empty --> crates/parser/src/grammar.rs:16:5 | 16 | //! ``` | _____^ 17 | | //! // test function_with_zero_parameters 18 | | //! // fn foo() {} 19 | | //! ``` | |_______^ | help: mark blocks that do not contain Rust code as text | 16 | //! ```text | ^^^^^^^ ``` https://github.com/rust-lang/rust/pull/79816 should make this configurable so the warning can be `allow`ed.
2021-01-18 21:44:40 +00:00
/// its `[package].name` can be different for other project types or even
/// 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 15:04:38 +00:00
pub display_name: Option<CrateDisplayName>,
2024-04-06 11:55:10 +00:00
pub cfg_options: Arc<CfgOptions>,
2023-03-31 12:10:33 +00:00
/// The cfg options that could be used by the crate
2024-04-06 11:55:10 +00:00
pub potential_cfg_options: Option<Arc<CfgOptions>>,
2020-03-09 10:14:51 +00:00
pub env: Env,
2020-03-09 09:26:46 +00:00
pub dependencies: Vec<Dependency>,
2021-11-22 17:44:46 +00:00
pub origin: CrateOrigin,
pub is_proc_macro: bool,
}
2024-04-19 09:43:16 +00:00
#[derive(Default, Clone, PartialEq, Eq)]
pub struct Env {
entries: FxHashMap<String, String>,
2020-03-11 03:04:02 +00:00
}
2020-03-10 13:59:12 +00:00
2024-04-19 09:43:16 +00:00
impl fmt::Debug for Env {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
struct EnvDebug<'s>(Vec<(&'s String, &'s String)>);
impl fmt::Debug for EnvDebug<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_map().entries(self.0.iter().copied()).finish()
}
}
f.debug_struct("Env")
.field("entries", &{
let mut entries: Vec<_> = self.entries.iter().collect();
entries.sort();
EnvDebug(entries)
})
.finish()
}
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
2018-12-05 13:01:18 +00:00
pub struct Dependency {
2018-12-08 22:05:49 +00:00
pub crate_id: CrateId,
2020-07-01 07:53:53 +00:00
pub name: CrateName,
prelude: bool,
sysroot: bool,
}
impl Dependency {
pub fn new(name: CrateName, crate_id: CrateId) -> Self {
Self { name, crate_id, prelude: true, sysroot: false }
}
pub fn with_prelude(name: CrateName, crate_id: CrateId, prelude: bool, sysroot: bool) -> Self {
Self { name, crate_id, prelude, sysroot }
}
/// Whether this dependency is to be added to the depending crate's extern prelude.
pub fn is_prelude(&self) -> bool {
self.prelude
}
/// Whether this dependency is a sysroot injected one.
pub fn is_sysroot(&self) -> bool {
self.sysroot
}
2018-12-08 21:51:06 +00:00
}
2018-12-05 13:01:18 +00:00
impl CrateGraph {
pub fn add_crate_root(
&mut self,
root_file_id: FileId,
edition: Edition,
2020-10-20 15:04:38 +00:00
display_name: Option<CrateDisplayName>,
version: Option<String>,
2024-04-06 11:55:10 +00:00
cfg_options: Arc<CfgOptions>,
potential_cfg_options: Option<Arc<CfgOptions>>,
mut env: Env,
is_proc_macro: bool,
2021-11-22 17:44:46 +00:00
origin: CrateOrigin,
) -> CrateId {
env.entries.shrink_to_fit();
2020-03-09 10:17:39 +00:00
let data = CrateData {
root_file_id,
2020-03-09 10:17:39 +00:00
edition,
version,
display_name,
2020-03-09 10:17:39 +00:00
cfg_options,
potential_cfg_options,
2020-03-09 10:17:39 +00:00
env,
dependencies: Vec::new(),
2021-11-22 17:44:46 +00:00
origin,
is_proc_macro,
2020-03-09 10:17:39 +00:00
};
self.arena.alloc(data)
2018-10-25 14:52:50 +00:00
}
pub fn add_dep(
&mut self,
from: CrateId,
dep: Dependency,
2019-11-22 11:12:45 +00:00
) -> Result<(), CyclicDependenciesError> {
let _p = tracing::info_span!("add_dep").entered();
// Check if adding a dep from `from` to `to` creates a cycle. To figure
// that out, look for a path in the *opposite* direction, from `to` to
// `from`.
if let Some(path) = self.find_path(&mut FxHashSet::default(), dep.crate_id, from) {
let path = path.into_iter().map(|it| (it, self[it].display_name.clone())).collect();
let err = CyclicDependenciesError { path };
assert!(err.from().0 == from && err.to().0 == dep.crate_id);
return Err(err);
}
self.arena[from].add_dep(dep);
2019-07-05 02:59:28 +00:00
Ok(())
2018-12-05 13:01:18 +00:00
}
2018-12-21 16:13:26 +00:00
pub fn is_empty(&self) -> bool {
self.arena.is_empty()
}
pub fn len(&self) -> usize {
self.arena.len()
}
pub fn iter(&self) -> impl Iterator<Item = CrateId> + '_ {
self.arena.iter().map(|(idx, _)| idx)
}
// FIXME: used for fixing up the toolchain sysroot, should be removed and done differently
#[doc(hidden)]
2023-06-05 11:27:19 +00:00
pub fn iter_mut(&mut self) -> impl Iterator<Item = (CrateId, &mut CrateData)> + '_ {
self.arena.iter_mut()
}
2021-03-23 09:58:48 +00:00
/// Returns an iterator over all transitive dependencies of the given crate,
/// including the crate itself.
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()
}
/// Returns all transitive reverse dependencies of the given crate,
/// including the crate itself.
pub fn transitive_rev_deps(&self, of: CrateId) -> impl Iterator<Item = CrateId> {
let mut worklist = vec![of];
let mut rev_deps = FxHashSet::default();
rev_deps.insert(of);
2021-03-23 10:01:45 +00:00
let mut inverted_graph = FxHashMap::<_, Vec<_>>::default();
self.arena.iter().for_each(|(krate, data)| {
data.dependencies
.iter()
.for_each(|dep| inverted_graph.entry(dep.crate_id).or_default().push(krate))
});
while let Some(krate) = worklist.pop() {
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));
}
}
rev_deps.into_iter()
}
/// 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.iter() {
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)
}
}
pub fn sort_deps(&mut self) {
self.arena
.iter_mut()
.for_each(|(_, data)| data.dependencies.sort_by_key(|dep| dep.crate_id));
}
2024-09-09 11:37:19 +00:00
/// Extends this crate graph by adding a complete second crate
2023-03-25 17:06:06 +00:00
/// graph and adjust the ids in the [`ProcMacroPaths`] accordingly.
///
2024-09-09 11:37:19 +00:00
/// Returns a map mapping `other`'s IDs to the new IDs in `self`.
pub fn extend(
&mut self,
mut other: CrateGraph,
proc_macros: &mut ProcMacroPaths,
) -> FxHashMap<CrateId, CrateId> {
let topo = other.crates_in_topological_order();
let mut id_map: FxHashMap<CrateId, CrateId> = FxHashMap::default();
for topo in topo {
let crate_data = &mut other.arena[topo];
2023-10-15 15:32:12 +00:00
crate_data.dependencies.iter_mut().for_each(|dep| dep.crate_id = id_map[&dep.crate_id]);
crate_data.dependencies.sort_by_key(|dep| dep.crate_id);
2024-09-09 11:37:19 +00:00
let new_id = self.arena.alloc(crate_data.clone());
id_map.insert(topo, new_id);
}
2023-03-25 17:06:06 +00:00
*proc_macros =
mem::take(proc_macros).into_iter().map(|(id, macros)| (id_map[&id], macros)).collect();
id_map
}
fn find_path(
&self,
visited: &mut FxHashSet<CrateId>,
from: CrateId,
to: CrateId,
) -> Option<Vec<CrateId>> {
if !visited.insert(from) {
return None;
2018-12-22 07:30:58 +00:00
}
if from == to {
return Some(vec![to]);
}
2020-03-09 10:11:59 +00:00
for dep in &self[from].dependencies {
2020-03-09 10:18:41 +00:00
let crate_id = dep.crate_id;
if let Some(mut path) = self.find_path(visited, crate_id, to) {
path.push(from);
return Some(path);
}
}
None
}
2022-07-08 13:44:49 +00:00
// Work around for https://github.com/rust-lang/rust-analyzer/issues/6038.
// As hacky as it gets.
pub fn patch_cfg_if(&mut self) -> bool {
// we stupidly max by version in an attempt to have all duplicated std's depend on the same cfg_if so that deduplication still works
let cfg_if =
self.hacky_find_crate("cfg_if").max_by_key(|&it| self.arena[it].version.clone());
let std = self.hacky_find_crate("std").next();
match (cfg_if, std) {
(Some(cfg_if), Some(std)) => {
self.arena[cfg_if].dependencies.clear();
self.arena[std]
.dependencies
.push(Dependency::new(CrateName::new("cfg_if").unwrap(), cfg_if));
true
}
_ => false,
}
}
fn hacky_find_crate<'a>(&'a self, display_name: &'a str) -> impl Iterator<Item = CrateId> + 'a {
self.iter().filter(move |it| self[*it].display_name.as_deref() == Some(display_name))
}
/// Removes all crates from this crate graph except for the ones in `to_keep` and fixes up the dependencies.
/// Returns a mapping from old crate ids to new crate ids.
pub fn remove_crates_except(&mut self, to_keep: &[CrateId]) -> Vec<Option<CrateId>> {
let mut id_map = vec![None; self.arena.len()];
self.arena = std::mem::take(&mut self.arena)
.into_iter()
.filter_map(|(id, data)| if to_keep.contains(&id) { Some((id, data)) } else { None })
.enumerate()
.map(|(new_id, (id, data))| {
id_map[id.into_raw().into_u32() as usize] =
Some(CrateId::from_raw(RawIdx::from_u32(new_id as u32)));
data
})
.collect();
for (_, data) in self.arena.iter_mut() {
data.dependencies.iter_mut().for_each(|dep| {
dep.crate_id =
id_map[dep.crate_id.into_raw().into_u32() as usize].expect("crate was filtered")
});
}
id_map
}
2024-03-21 19:08:30 +00:00
pub fn shrink_to_fit(&mut self) {
self.arena.shrink_to_fit();
}
2018-10-25 14:52:50 +00:00
}
2020-03-09 10:11:59 +00:00
impl ops::Index<CrateId> for CrateGraph {
type Output = CrateData;
fn index(&self, crate_id: CrateId) -> &CrateData {
&self.arena[crate_id]
2019-11-22 11:12:45 +00:00
}
}
impl CrateData {
/// Add a dependency to `self` without checking if the dependency
// is existent among `self.dependencies`.
2023-11-21 13:05:31 +00:00
fn add_dep(&mut self, dep: Dependency) {
self.dependencies.push(dep)
2019-11-22 11:12:45 +00:00
}
pub fn root_file_id(&self) -> EditionedFileId {
EditionedFileId::new(self.root_file_id, self.edition)
}
2019-11-22 11:08:18 +00:00
}
impl Extend<(String, String)> for Env {
fn extend<T: IntoIterator<Item = (String, String)>>(&mut self, iter: T) {
self.entries.extend(iter);
}
}
2020-07-21 15:17:21 +00:00
impl FromIterator<(String, String)> for Env {
fn from_iter<T: IntoIterator<Item = (String, String)>>(iter: T) -> Self {
Env { entries: FromIterator::from_iter(iter) }
}
}
impl Env {
pub fn set(&mut self, env: &str, value: impl Into<String>) {
self.entries.insert(env.to_owned(), value.into());
}
pub fn get(&self, env: &str) -> Option<String> {
self.entries.get(env).cloned()
}
2020-12-11 13:57:50 +00:00
2024-04-19 09:43:16 +00:00
pub fn extend_from_other(&mut self, other: &Env) {
self.entries.extend(other.entries.iter().map(|(x, y)| (x.to_owned(), y.to_owned())));
}
pub fn is_empty(&self) -> bool {
self.entries.is_empty()
}
pub fn insert(&mut self, k: impl Into<String>, v: impl Into<String>) -> Option<String> {
self.entries.insert(k.into(), v.into())
}
2024-04-19 09:43:16 +00:00
}
impl From<Env> for Vec<(String, String)> {
fn from(env: Env) -> Vec<(String, String)> {
let mut entries: Vec<_> = env.entries.into_iter().collect();
entries.sort();
entries
2020-12-11 13:57:50 +00:00
}
2020-03-11 03:04:02 +00:00
}
2020-03-10 13:59:12 +00:00
impl<'a> IntoIterator for &'a Env {
type Item = (&'a String, &'a String);
type IntoIter = std::collections::hash_map::Iter<'a, String, String>;
fn into_iter(self) -> Self::IntoIter {
self.entries.iter()
}
}
2019-11-22 11:12:45 +00:00
#[derive(Debug)]
2020-11-17 10:50:54 +00:00
pub struct CyclicDependenciesError {
path: Vec<(CrateId, Option<CrateDisplayName>)>,
}
impl CyclicDependenciesError {
fn from(&self) -> &(CrateId, Option<CrateDisplayName>) {
self.path.first().unwrap()
}
fn to(&self) -> &(CrateId, Option<CrateDisplayName>) {
self.path.last().unwrap()
}
2020-11-17 10:50:54 +00:00
}
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:?}"),
2020-11-17 10:50:54 +00:00
};
let path = self.path.iter().rev().map(render).collect::<Vec<String>>().join(" -> ");
write!(
f,
"cyclic deps: {} -> {}, alternative path: {}",
2021-09-03 14:00:50 +00:00
render(self.from()),
render(self.to()),
path
)
2020-11-17 10:50:54 +00:00
}
}
2019-11-22 11:12:45 +00:00
#[cfg(test)]
mod tests {
use crate::CrateOrigin;
2023-03-31 12:10:33 +00:00
use super::{CrateGraph, CrateName, Dependency, Edition::Edition2018, Env, FileId};
#[test]
fn detect_cyclic_dependency_indirect() {
let mut graph = CrateGraph::default();
2020-03-08 13:26:57 +00:00
let crate1 = graph.add_crate_root(
FileId::from_raw(1u32),
2020-03-08 13:26:57 +00:00
Edition2018,
None,
None,
2023-03-31 12:10:33 +00:00
Default::default(),
Default::default(),
2020-03-08 13:26:57 +00:00
Env::default(),
false,
2023-03-31 07:10:18 +00:00
CrateOrigin::Local { repo: None, name: None },
2020-03-08 13:26:57 +00:00
);
let crate2 = graph.add_crate_root(
FileId::from_raw(2u32),
2020-03-08 13:26:57 +00:00
Edition2018,
None,
None,
2023-03-31 12:10:33 +00:00
Default::default(),
Default::default(),
2020-03-08 13:26:57 +00:00
Env::default(),
false,
2023-03-31 07:10:18 +00:00
CrateOrigin::Local { repo: None, name: None },
2020-03-08 13:26:57 +00:00
);
let crate3 = graph.add_crate_root(
FileId::from_raw(3u32),
2020-03-08 13:26:57 +00:00
Edition2018,
None,
None,
2023-03-31 12:10:33 +00:00
Default::default(),
Default::default(),
2020-03-08 13:26:57 +00:00
Env::default(),
false,
2023-03-31 07:10:18 +00:00
CrateOrigin::Local { repo: None, name: None },
2020-03-08 13:26:57 +00:00
);
assert!(graph
.add_dep(crate1, Dependency::new(CrateName::new("crate2").unwrap(), crate2,))
.is_ok());
assert!(graph
.add_dep(crate2, Dependency::new(CrateName::new("crate3").unwrap(), crate3,))
.is_ok());
assert!(graph
.add_dep(crate3, Dependency::new(CrateName::new("crate1").unwrap(), crate1,))
.is_err());
}
#[test]
fn detect_cyclic_dependency_direct() {
let mut graph = CrateGraph::default();
let crate1 = graph.add_crate_root(
FileId::from_raw(1u32),
Edition2018,
None,
None,
2023-03-31 12:10:33 +00:00
Default::default(),
Default::default(),
Env::default(),
false,
2023-03-31 07:10:18 +00:00
CrateOrigin::Local { repo: None, name: None },
);
let crate2 = graph.add_crate_root(
FileId::from_raw(2u32),
Edition2018,
None,
None,
2023-03-31 12:10:33 +00:00
Default::default(),
Default::default(),
Env::default(),
false,
2023-03-31 07:10:18 +00:00
CrateOrigin::Local { repo: None, name: None },
);
assert!(graph
.add_dep(crate1, Dependency::new(CrateName::new("crate2").unwrap(), crate2,))
.is_ok());
assert!(graph
.add_dep(crate2, Dependency::new(CrateName::new("crate2").unwrap(), crate2,))
.is_err());
}
#[test]
fn it_works() {
let mut graph = CrateGraph::default();
2020-03-08 13:26:57 +00:00
let crate1 = graph.add_crate_root(
FileId::from_raw(1u32),
2020-03-08 13:26:57 +00:00
Edition2018,
None,
None,
2023-03-31 12:10:33 +00:00
Default::default(),
Default::default(),
2020-03-08 13:26:57 +00:00
Env::default(),
false,
2023-03-31 07:10:18 +00:00
CrateOrigin::Local { repo: None, name: None },
2020-03-08 13:26:57 +00:00
);
let crate2 = graph.add_crate_root(
FileId::from_raw(2u32),
2020-03-08 13:26:57 +00:00
Edition2018,
None,
None,
2023-03-31 12:10:33 +00:00
Default::default(),
Default::default(),
2020-03-08 13:26:57 +00:00
Env::default(),
false,
2023-03-31 07:10:18 +00:00
CrateOrigin::Local { repo: None, name: None },
2020-03-08 13:26:57 +00:00
);
let crate3 = graph.add_crate_root(
FileId::from_raw(3u32),
2020-03-08 13:26:57 +00:00
Edition2018,
None,
None,
2023-03-31 12:10:33 +00:00
Default::default(),
Default::default(),
2020-03-08 13:26:57 +00:00
Env::default(),
false,
2023-03-31 07:10:18 +00:00
CrateOrigin::Local { repo: None, name: None },
2020-03-08 13:26:57 +00:00
);
assert!(graph
.add_dep(crate1, Dependency::new(CrateName::new("crate2").unwrap(), crate2,))
.is_ok());
assert!(graph
.add_dep(crate2, Dependency::new(CrateName::new("crate3").unwrap(), crate3,))
.is_ok());
2020-02-05 09:53:54 +00:00
}
#[test]
fn dashes_are_normalized() {
let mut graph = CrateGraph::default();
2020-03-08 13:26:57 +00:00
let crate1 = graph.add_crate_root(
FileId::from_raw(1u32),
2020-03-08 13:26:57 +00:00
Edition2018,
None,
None,
2023-03-31 12:10:33 +00:00
Default::default(),
Default::default(),
2020-03-08 13:26:57 +00:00
Env::default(),
false,
2023-03-31 07:10:18 +00:00
CrateOrigin::Local { repo: None, name: None },
2020-03-08 13:26:57 +00:00
);
let crate2 = graph.add_crate_root(
FileId::from_raw(2u32),
2020-03-08 13:26:57 +00:00
Edition2018,
None,
None,
2023-03-31 12:10:33 +00:00
Default::default(),
Default::default(),
2020-03-08 13:26:57 +00:00
Env::default(),
false,
2023-03-31 07:10:18 +00:00
CrateOrigin::Local { repo: None, name: None },
2020-03-08 13:26:57 +00:00
);
2020-02-05 10:47:28 +00:00
assert!(graph
.add_dep(
crate1,
Dependency::new(CrateName::normalize_dashes("crate-name-with-dashes"), crate2,)
)
2020-02-05 10:47:28 +00:00
.is_ok());
2020-02-05 09:53:54 +00:00
assert_eq!(
2020-03-09 10:11:59 +00:00
graph[crate1].dependencies,
vec![Dependency::new(CrateName::new("crate_name_with_dashes").unwrap(), crate2,)]
2020-02-05 09:53:54 +00:00
);
}
}