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

137 lines
4.4 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, semicolon_in_expressions_from_macros)]
mod input;
mod change;
pub mod fixture;
2019-04-09 14:52:06 -05:00
use std::{panic, sync::Arc};
2019-01-09 13:51:05 -06:00
use rustc_hash::FxHashSet;
2020-08-12 11:26:51 -05:00
use syntax::{ast, Parse, SourceFile, TextRange, TextSize};
pub use crate::{
change::Change,
2020-02-05 04:47:28 -06:00
input::{
2021-11-22 11:44:46 -06:00
CrateData, CrateDisplayName, CrateGraph, CrateId, CrateName, CrateOrigin, Dependency,
Edition, Env, LangCrateOrigin, ProcMacro, ProcMacroExpander, ProcMacroExpansionError,
2023-03-31 02:10:18 -05:00
ProcMacroId, ProcMacroKind, ProcMacroLoadResult, ProcMacroPaths, ProcMacros,
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};
2020-12-09 09:41:35 -06:00
pub use vfs::{file_set::FileSet, AnchoredPath, AnchoredPathBuf, FileId, VfsPath};
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;
}
2018-11-27 18:42:26 -06:00
#[derive(Clone, Copy, Debug)]
pub struct FilePosition {
pub file_id: FileId,
2020-04-24 16:40:41 -05:00
pub offset: TextSize,
2018-11-27 18:42:26 -06:00
}
2018-12-28 09:03:03 -06:00
#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
2018-12-28 09:03:03 -06:00
pub struct FileRange {
pub file_id: FileId,
pub range: TextRange,
}
2019-01-25 06:16:50 -06:00
2019-06-07 04:46:49 -05:00
pub const DEFAULT_LRU_CAP: usize = 128;
pub trait FileLoader {
2019-01-25 06:16:50 -06:00
/// Text of the file.
fn file_text(&self, file_id: FileId) -> Arc<String>;
2022-07-20 08:02:08 -05:00
fn resolve_path(&self, path: AnchoredPath<'_>) -> Option<FileId>;
fn relevant_crates(&self, file_id: FileId) -> Arc<FxHashSet<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 {
// Parses the file into the syntax tree.
#[salsa::invoke(parse_query)]
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>;
/// The crate graph.
#[salsa::input]
fn proc_macros(&self) -> Arc<ProcMacros>;
}
fn parse_query(db: &dyn SourceDatabase, file_id: FileId) -> Parse<ast::SourceFile> {
let _p = profile::span("parse_query").detail(|| format!("{file_id:?}"));
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]
fn file_text(&self, file_id: FileId) -> Arc<String>;
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<FxHashSet<CrateId>>;
}
fn source_root_crates(db: &dyn SourceDatabaseExt, id: SourceRootId) -> Arc<FxHashSet<CrateId>> {
2019-01-25 06:16:50 -06:00
let graph = db.crate_graph();
2020-06-11 04:30:06 -05:00
let res = graph
.iter()
.filter(|&krate| {
let root_file = graph[krate].root_file_id;
db.file_source_root(root_file) == id
})
2021-11-29 03:36:00 -06:00
.collect();
2019-01-25 06:16:50 -06:00
Arc::new(res)
}
/// Silly workaround for cyclic deps between the traits
pub struct FileLoaderDelegate<T>(pub T);
impl<T: SourceDatabaseExt> FileLoader for FileLoaderDelegate<&'_ T> {
fn file_text(&self, file_id: FileId) -> Arc<String> {
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<FxHashSet<CrateId>> {
2021-06-10 15:03:16 -05:00
let _p = profile::span("relevant_crates");
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
}