rust/crates/base-db/src/lib.rs

138 lines
4.5 KiB
Rust
Raw Normal View History

2020-08-13 10:42:52 -05:00
//! base_db defines basic database traits. The concrete DB is defined by ide.
#![warn(rust_2018_idioms, unused_lifetimes)]
mod change;
2024-01-26 13:08:10 -06:00
mod input;
2023-05-02 09:12:22 -05:00
use std::panic;
2019-01-09 13:51:05 -06:00
2023-12-18 06:30:41 -06:00
use syntax::{ast, Parse, SourceFile};
2023-05-02 09:12:22 -05:00
use triomphe::Arc;
pub use crate::{
change::FileChange,
2020-02-05 04:47:28 -06:00
input::{
2021-11-22 11:44:46 -06:00
CrateData, CrateDisplayName, CrateGraph, CrateId, CrateName, CrateOrigin, Dependency,
DependencyKind, Edition, Env, LangCrateOrigin, ProcMacroPaths, ReleaseChannel, SourceRoot,
SourceRootId, TargetLayoutLoadResult,
2020-02-05 04:47:28 -06:00
},
};
2021-05-17 12:07:10 -05:00
pub use salsa::{self, Cancelled};
2023-12-18 06:30:41 -06:00
pub use span::{FilePosition, FileRange};
2020-12-09 09:41:35 -06:00
pub use vfs::{file_set::FileSet, AnchoredPath, AnchoredPathBuf, FileId, VfsPath};
pub use semver::{BuildMetadata, Prerelease, Version, VersionReq};
2019-11-24 05:13:51 -06:00
#[macro_export]
macro_rules! impl_intern_key {
($name:ident) => {
impl $crate::salsa::InternKey for $name {
fn from_intern_id(v: $crate::salsa::InternId) -> Self {
$name(v)
}
fn as_intern_id(&self) -> $crate::salsa::InternId {
self.0
}
}
};
}
pub trait Upcast<T: ?Sized> {
fn upcast(&self) -> &T;
}
pub const DEFAULT_PARSE_LRU_CAP: usize = 128;
2024-03-07 02:33:48 -06:00
pub const DEFAULT_BORROWCK_LRU_CAP: usize = 1024;
2019-06-07 04:46:49 -05:00
pub trait FileLoader {
2019-01-25 06:16:50 -06:00
/// Text of the file.
2023-04-22 02:48:37 -05:00
fn file_text(&self, file_id: FileId) -> Arc<str>;
2022-07-20 08:02:08 -05:00
fn resolve_path(&self, path: AnchoredPath<'_>) -> Option<FileId>;
fn relevant_crates(&self, file_id: FileId) -> Arc<[CrateId]>;
}
/// Database which stores all significant input facts: source code and project
/// model. Everything else in rust-analyzer is derived from these queries.
#[salsa::query_group(SourceDatabaseStorage)]
2021-05-17 12:07:10 -05:00
pub trait SourceDatabase: FileLoader + std::fmt::Debug {
2023-11-25 08:10:31 -06:00
/// Parses the file into the syntax tree.
2019-07-18 14:29:20 -05:00
fn parse(&self, file_id: FileId) -> Parse<ast::SourceFile>;
/// The crate graph.
#[salsa::input]
fn crate_graph(&self) -> Arc<CrateGraph>;
// FIXME: Consider removing this, making HirDatabase::target_data_layout an input query
#[salsa::input]
fn data_layout(&self, krate: CrateId) -> TargetLayoutLoadResult;
#[salsa::input]
fn toolchain(&self, krate: CrateId) -> Option<Version>;
#[salsa::transparent]
fn toolchain_channel(&self, krate: CrateId) -> Option<ReleaseChannel>;
}
fn toolchain_channel(db: &dyn SourceDatabase, krate: CrateId) -> Option<ReleaseChannel> {
db.toolchain(krate).as_ref().and_then(|v| ReleaseChannel::from_str(&v.pre))
}
2023-11-25 08:10:31 -06:00
fn parse(db: &dyn SourceDatabase, file_id: FileId) -> Parse<ast::SourceFile> {
let _p = tracing::span!(tracing::Level::INFO, "parse_query", ?file_id).entered();
let text = db.file_text(file_id);
SourceFile::parse(&text)
}
/// We don't want to give HIR knowledge of source roots, hence we extract these
/// methods into a separate DB.
#[salsa::query_group(SourceDatabaseExtStorage)]
pub trait SourceDatabaseExt: SourceDatabase {
#[salsa::input]
2023-04-22 02:48:37 -05:00
fn file_text(&self, file_id: FileId) -> Arc<str>;
2019-01-25 06:16:50 -06:00
/// Path to a file, relative to the root of its source root.
/// Source root of the file.
#[salsa::input]
fn file_source_root(&self, file_id: FileId) -> SourceRootId;
/// Contents of the source root.
#[salsa::input]
fn source_root(&self, id: SourceRootId) -> Arc<SourceRoot>;
fn source_root_crates(&self, id: SourceRootId) -> Arc<[CrateId]>;
}
fn source_root_crates(db: &dyn SourceDatabaseExt, id: SourceRootId) -> Arc<[CrateId]> {
2019-01-25 06:16:50 -06:00
let graph = db.crate_graph();
let mut crates = graph
2020-06-11 04:30:06 -05:00
.iter()
.filter(|&krate| {
let root_file = graph[krate].root_file_id;
db.file_source_root(root_file) == id
})
.collect::<Vec<_>>();
crates.sort();
crates.dedup();
crates.into_iter().collect()
2019-01-25 06:16:50 -06:00
}
/// Silly workaround for cyclic deps between the traits
pub struct FileLoaderDelegate<T>(pub T);
impl<T: SourceDatabaseExt> FileLoader for FileLoaderDelegate<&'_ T> {
2023-04-22 02:48:37 -05:00
fn file_text(&self, file_id: FileId) -> Arc<str> {
SourceDatabaseExt::file_text(self.0, file_id)
}
2022-07-20 08:02:08 -05:00
fn resolve_path(&self, path: AnchoredPath<'_>) -> Option<FileId> {
2020-06-05 09:45:20 -05:00
// FIXME: this *somehow* should be platform agnostic...
2020-12-09 09:41:35 -06:00
let source_root = self.0.file_source_root(path.anchor);
2020-06-11 04:04:09 -05:00
let source_root = self.0.source_root(source_root);
source_root.resolve_path(path)
}
fn relevant_crates(&self, file_id: FileId) -> Arc<[CrateId]> {
let _p = tracing::span!(tracing::Level::INFO, "relevant_crates").entered();
let source_root = self.0.file_source_root(file_id);
self.0.source_root_crates(source_root)
}
2019-01-25 06:16:50 -06:00
}