2019-11-27 12:32:33 -06:00
|
|
|
//! ra_db defines basic database traits. The concrete DB is defined by ra_ide.
|
2019-01-08 17:47:12 -06:00
|
|
|
mod cancellation;
|
2018-11-27 18:25:20 -06:00
|
|
|
mod input;
|
2019-11-03 11:53:17 -06:00
|
|
|
pub mod fixture;
|
2018-11-27 18:25:20 -06:00
|
|
|
|
2019-04-09 14:52:06 -05:00
|
|
|
use std::{panic, sync::Arc};
|
2019-01-09 13:51:05 -06:00
|
|
|
|
2019-05-22 03:31:07 -05:00
|
|
|
use ra_prof::profile;
|
2019-07-18 14:29:20 -05:00
|
|
|
use ra_syntax::{ast, Parse, SourceFile, TextRange, TextUnit};
|
2018-11-27 18:25:20 -06:00
|
|
|
|
|
|
|
pub use crate::{
|
2019-01-15 12:02:42 -06:00
|
|
|
cancellation::Canceled,
|
2020-02-05 04:47:28 -06:00
|
|
|
input::{
|
2020-03-10 22:04:02 -05:00
|
|
|
CrateGraph, CrateId, CrateName, Dependency, Edition, Env, ExternSource, ExternSourceId,
|
|
|
|
FileId, SourceRoot, SourceRootId,
|
2020-02-05 04:47:28 -06:00
|
|
|
},
|
2018-11-27 18:25:20 -06:00
|
|
|
};
|
2019-11-03 11:53:17 -06:00
|
|
|
pub use relative_path::{RelativePath, RelativePathBuf};
|
2019-09-05 14:36:04 -05:00
|
|
|
pub use salsa;
|
2018-11-27 18:25:20 -06:00
|
|
|
|
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
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2020-03-13 10:05:46 -05:00
|
|
|
pub trait Upcast<T: ?Sized> {
|
|
|
|
fn upcast(&self) -> &T;
|
|
|
|
}
|
|
|
|
|
2019-05-18 05:04:09 -05:00
|
|
|
pub trait CheckCanceled {
|
2019-01-15 06:45:48 -06:00
|
|
|
/// Aborts current query if there are pending changes.
|
|
|
|
///
|
|
|
|
/// rust-analyzer needs to be able to answer semantic questions about the
|
|
|
|
/// code while the code is being modified. A common problem is that a
|
|
|
|
/// long-running query is being calculated when a new change arrives.
|
|
|
|
///
|
|
|
|
/// We can't just apply the change immediately: this will cause the pending
|
|
|
|
/// query to see inconsistent state (it will observe an absence of
|
|
|
|
/// repeatable read). So what we do is we **cancel** all pending queries
|
|
|
|
/// before applying the change.
|
|
|
|
///
|
|
|
|
/// We implement cancellation by panicking with a special value and catching
|
|
|
|
/// it on the API boundary. Salsa explicitly supports this use-case.
|
2019-02-03 13:15:31 -06:00
|
|
|
fn check_canceled(&self);
|
2019-01-09 13:51:05 -06:00
|
|
|
|
2019-02-03 13:15:31 -06:00
|
|
|
fn catch_canceled<F, T>(&self, f: F) -> Result<T, Canceled>
|
|
|
|
where
|
2019-09-27 12:47:36 -05:00
|
|
|
Self: Sized + panic::RefUnwindSafe,
|
2019-02-03 13:15:31 -06:00
|
|
|
F: FnOnce(&Self) -> T + panic::UnwindSafe,
|
|
|
|
{
|
2019-09-27 12:47:36 -05:00
|
|
|
panic::catch_unwind(|| f(self)).map_err(|err| match err.downcast::<Canceled>() {
|
2019-01-10 03:20:32 -06:00
|
|
|
Ok(canceled) => *canceled,
|
2019-01-09 13:51:05 -06:00
|
|
|
Err(payload) => panic::resume_unwind(payload),
|
|
|
|
})
|
2018-11-27 18:25:20 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-05-18 05:04:09 -05:00
|
|
|
impl<T: salsa::Database> CheckCanceled for T {
|
2019-02-03 13:15:31 -06:00
|
|
|
fn check_canceled(&self) {
|
|
|
|
if self.salsa_runtime().is_current_revision_canceled() {
|
|
|
|
Canceled::throw()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-11-27 18:42:26 -06:00
|
|
|
#[derive(Clone, Copy, Debug)]
|
|
|
|
pub struct FilePosition {
|
|
|
|
pub file_id: FileId,
|
|
|
|
pub offset: TextUnit,
|
|
|
|
}
|
2018-12-28 09:03:03 -06:00
|
|
|
|
|
|
|
#[derive(Clone, Copy, Debug)]
|
|
|
|
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;
|
|
|
|
|
2019-10-14 08:20:55 -05:00
|
|
|
pub trait FileLoader {
|
2019-01-25 06:16:50 -06:00
|
|
|
/// Text of the file.
|
|
|
|
fn file_text(&self, file_id: FileId) -> Arc<String>;
|
2019-10-09 06:27:37 -05:00
|
|
|
fn resolve_relative_path(&self, anchor: FileId, relative_path: &RelativePath)
|
|
|
|
-> Option<FileId>;
|
2019-10-14 08:20:55 -05:00
|
|
|
fn relevant_crates(&self, file_id: FileId) -> Arc<Vec<CrateId>>;
|
2020-03-10 09:00:31 -05:00
|
|
|
|
|
|
|
fn resolve_extern_path(
|
|
|
|
&self,
|
|
|
|
extern_id: ExternSourceId,
|
|
|
|
relative_path: &RelativePath,
|
|
|
|
) -> Option<FileId>;
|
2019-10-14 08:20:55 -05:00
|
|
|
}
|
2019-10-09 06:27:37 -05:00
|
|
|
|
2019-10-14 08:20:55 -05:00
|
|
|
/// 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)]
|
|
|
|
pub trait SourceDatabase: CheckCanceled + FileLoader + std::fmt::Debug {
|
2019-01-26 02:09:39 -06:00
|
|
|
// Parses the file into the syntax tree.
|
2019-05-22 03:31:07 -05:00
|
|
|
#[salsa::invoke(parse_query)]
|
2019-07-18 14:29:20 -05:00
|
|
|
fn parse(&self, file_id: FileId) -> Parse<ast::SourceFile>;
|
2019-10-14 08:20:55 -05:00
|
|
|
|
|
|
|
/// The crate graph.
|
|
|
|
#[salsa::input]
|
|
|
|
fn crate_graph(&self) -> Arc<CrateGraph>;
|
|
|
|
}
|
|
|
|
|
|
|
|
fn parse_query(db: &impl SourceDatabase, file_id: FileId) -> Parse<ast::SourceFile> {
|
|
|
|
let _p = profile("parse_query");
|
|
|
|
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.
|
|
|
|
#[salsa::input]
|
|
|
|
fn file_relative_path(&self, file_id: FileId) -> RelativePathBuf;
|
|
|
|
/// 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>;
|
|
|
|
|
2019-10-14 08:20:55 -05:00
|
|
|
fn source_root_crates(&self, id: SourceRootId) -> Arc<Vec<CrateId>>;
|
2019-10-09 06:27:37 -05:00
|
|
|
}
|
|
|
|
|
2019-10-14 08:20:55 -05:00
|
|
|
fn source_root_crates(
|
|
|
|
db: &(impl SourceDatabaseExt + SourceDatabase),
|
|
|
|
id: SourceRootId,
|
|
|
|
) -> Arc<Vec<CrateId>> {
|
2019-01-25 06:16:50 -06:00
|
|
|
let root = db.source_root(id);
|
|
|
|
let graph = db.crate_graph();
|
2019-09-05 14:36:04 -05:00
|
|
|
let res = root.walk().filter_map(|it| graph.crate_id_for_crate_root(it)).collect::<Vec<_>>();
|
2019-01-25 06:16:50 -06:00
|
|
|
Arc::new(res)
|
|
|
|
}
|
|
|
|
|
2019-10-14 08:20:55 -05:00
|
|
|
/// 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)
|
|
|
|
}
|
|
|
|
fn resolve_relative_path(
|
|
|
|
&self,
|
|
|
|
anchor: FileId,
|
|
|
|
relative_path: &RelativePath,
|
|
|
|
) -> Option<FileId> {
|
|
|
|
let path = {
|
|
|
|
let mut path = self.0.file_relative_path(anchor);
|
2019-10-27 04:36:40 -05:00
|
|
|
assert!(path.pop());
|
2019-10-14 08:20:55 -05:00
|
|
|
path.push(relative_path);
|
|
|
|
path.normalize()
|
|
|
|
};
|
|
|
|
let source_root = self.0.file_source_root(anchor);
|
|
|
|
let source_root = self.0.source_root(source_root);
|
|
|
|
source_root.file_by_relative_path(&path)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn relevant_crates(&self, file_id: FileId) -> Arc<Vec<CrateId>> {
|
|
|
|
let source_root = self.0.file_source_root(file_id);
|
|
|
|
self.0.source_root_crates(source_root)
|
|
|
|
}
|
2020-03-10 09:00:31 -05:00
|
|
|
|
|
|
|
fn resolve_extern_path(
|
|
|
|
&self,
|
|
|
|
extern_id: ExternSourceId,
|
|
|
|
relative_path: &RelativePath,
|
|
|
|
) -> Option<FileId> {
|
|
|
|
let source_root = self.0.source_root(SourceRootId(extern_id.0));
|
|
|
|
source_root.file_by_relative_path(&relative_path)
|
|
|
|
}
|
2019-01-25 06:16:50 -06:00
|
|
|
}
|