rust/crates/hir/src/has_source.rs

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

189 lines
6.5 KiB
Rust
Raw Normal View History

2020-08-14 13:43:34 -05:00
//! Provides set of implementation for hir's objects that allows get back location in file.
use either::Either;
use hir_def::{
2020-06-11 04:04:09 -05:00
nameres::{ModuleOrigin, ModuleSource},
src::{HasChildSource, HasSource as _},
2022-03-08 16:51:48 -06:00
Lookup, MacroId, VariantId,
};
use hir_expand::InFile;
2020-08-12 11:26:51 -05:00
use syntax::ast;
2019-06-11 10:00:08 -05:00
use crate::{
db::HirDatabase, Adt, Const, Enum, Field, FieldSource, Function, Impl, LifetimeParam,
LocalSource, Macro, Module, Static, Struct, Trait, TypeAlias, TraitAlias, TypeOrConstParam, Union, Variant,
2019-06-11 10:00:08 -05:00
};
pub trait HasSource {
type Ast;
/// Fetches the definition's source node.
/// Using [`crate::Semantics::source`] is preferred when working with [`crate::Semantics`],
/// as that caches the parsed file in the semantics' cache.
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>>;
2019-06-11 10:00:08 -05:00
}
2019-06-11 10:11:17 -05:00
/// NB: Module is !HasSource, because it has two source nodes at the same time:
2019-06-11 10:00:08 -05:00
/// definition and declaration.
impl Module {
/// Returns a node which defines this module. That is, a file or a `mod foo {}` with items.
pub fn definition_source(self, db: &dyn HirDatabase) -> InFile<ModuleSource> {
let def_map = self.id.def_map(db.upcast());
def_map[self.id.local_id].definition_source(db.upcast())
2019-06-11 10:00:08 -05:00
}
2020-06-11 04:04:09 -05:00
pub fn is_mod_rs(self, db: &dyn HirDatabase) -> bool {
let def_map = self.id.def_map(db.upcast());
2020-06-11 04:04:09 -05:00
match def_map[self.id.local_id].origin {
ModuleOrigin::File { is_mod_rs, .. } => is_mod_rs,
_ => false,
}
}
pub fn is_inline(self, db: &dyn HirDatabase) -> bool {
let def_map = self.id.def_map(db.upcast());
def_map[self.id.local_id].origin.is_inline()
}
2019-06-11 10:00:08 -05:00
/// Returns a node which declares this module, either a `mod foo;` or a `mod foo {}`.
/// `None` for the crate root.
pub fn declaration_source(self, db: &dyn HirDatabase) -> Option<InFile<ast::Module>> {
let def_map = self.id.def_map(db.upcast());
def_map[self.id.local_id].declaration_source(db.upcast())
2019-06-11 10:00:08 -05:00
}
}
2020-04-25 07:23:34 -05:00
impl HasSource for Field {
2019-06-11 10:00:08 -05:00
type Ast = FieldSource;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
let var = VariantId::from(self.parent);
let src = var.child_source(db.upcast());
let field_source = src.map(|it| match it[self.id].clone() {
Either::Left(it) => FieldSource::Pos(it),
Either::Right(it) => FieldSource::Named(it),
});
Some(field_source)
}
2019-06-11 10:00:08 -05:00
}
impl HasSource for Adt {
type Ast = ast::Adt;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
match self {
2021-09-03 09:00:50 -05:00
Adt::Struct(s) => Some(s.source(db)?.map(ast::Adt::Struct)),
Adt::Union(u) => Some(u.source(db)?.map(ast::Adt::Union)),
Adt::Enum(e) => Some(e.source(db)?.map(ast::Adt::Enum)),
}
}
}
2019-06-11 10:00:08 -05:00
impl HasSource for Struct {
2020-07-30 10:50:40 -05:00
type Ast = ast::Struct;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
Some(self.id.lookup(db.upcast()).source(db.upcast()))
}
2019-06-11 10:00:08 -05:00
}
impl HasSource for Union {
2020-07-30 10:36:46 -05:00
type Ast = ast::Union;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
Some(self.id.lookup(db.upcast()).source(db.upcast()))
}
2019-06-11 10:00:08 -05:00
}
impl HasSource for Enum {
2020-07-30 10:52:53 -05:00
type Ast = ast::Enum;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
Some(self.id.lookup(db.upcast()).source(db.upcast()))
}
2019-06-11 10:00:08 -05:00
}
2020-12-20 01:05:24 -06:00
impl HasSource for Variant {
2020-07-30 10:56:53 -05:00
type Ast = ast::Variant;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<ast::Variant>> {
Some(self.parent.id.child_source(db.upcast()).map(|map| map[self.id].clone()))
}
2019-06-11 10:00:08 -05:00
}
impl HasSource for Function {
2020-07-30 07:51:08 -05:00
type Ast = ast::Fn;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
Some(self.id.lookup(db.upcast()).source(db.upcast()))
}
2019-06-11 10:00:08 -05:00
}
impl HasSource for Const {
2020-07-30 11:02:20 -05:00
type Ast = ast::Const;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
Some(self.id.lookup(db.upcast()).source(db.upcast()))
}
2019-06-11 10:00:08 -05:00
}
impl HasSource for Static {
2020-07-30 11:02:20 -05:00
type Ast = ast::Static;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
Some(self.id.lookup(db.upcast()).source(db.upcast()))
}
2019-06-11 10:00:08 -05:00
}
impl HasSource for Trait {
2020-07-30 11:17:28 -05:00
type Ast = ast::Trait;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
Some(self.id.lookup(db.upcast()).source(db.upcast()))
}
2019-06-11 10:00:08 -05:00
}
2023-03-03 09:24:07 -06:00
impl HasSource for TraitAlias {
type Ast = ast::TraitAlias;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
Some(self.id.lookup(db.upcast()).source(db.upcast()))
}
}
2019-06-11 10:00:08 -05:00
impl HasSource for TypeAlias {
2020-07-30 08:25:46 -05:00
type Ast = ast::TypeAlias;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
Some(self.id.lookup(db.upcast()).source(db.upcast()))
}
2019-06-11 10:00:08 -05:00
}
2022-03-08 16:51:48 -06:00
impl HasSource for Macro {
2021-03-18 10:11:18 -05:00
type Ast = Either<ast::Macro, ast::Fn>;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
2022-03-08 16:51:48 -06:00
match self.id {
MacroId::Macro2Id(it) => Some(
it.lookup(db.upcast())
.source(db.upcast())
.map(ast::Macro::MacroDef)
.map(Either::Left),
),
MacroId::MacroRulesId(it) => Some(
it.lookup(db.upcast())
.source(db.upcast())
.map(ast::Macro::MacroRules)
.map(Either::Left),
),
MacroId::ProcMacroId(it) => {
Some(it.lookup(db.upcast()).source(db.upcast()).map(Either::Right))
}
}
}
2019-06-11 10:00:08 -05:00
}
impl HasSource for Impl {
2020-07-30 11:28:28 -05:00
type Ast = ast::Impl;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
Some(self.id.lookup(db.upcast()).source(db.upcast()))
}
2019-11-24 12:03:24 -06:00
}
2019-12-07 11:24:52 -06:00
2021-12-29 07:35:59 -06:00
impl HasSource for TypeOrConstParam {
2023-03-03 09:24:07 -06:00
type Ast = Either<ast::TypeOrConstParam, ast::TraitOrAlias>;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
let child_source = self.id.parent.child_source(db.upcast());
Some(child_source.map(|it| it[self.id.local_id].clone()))
}
}
impl HasSource for LifetimeParam {
type Ast = ast::LifetimeParam;
fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
let child_source = self.id.parent.child_source(db.upcast());
Some(child_source.map(|it| it[self.id.local_id].clone()))
}
2019-12-07 11:24:52 -06:00
}
impl HasSource for LocalSource {
type Ast = Either<ast::IdentPat, ast::SelfParam>;
fn source(self, _: &dyn HirDatabase) -> Option<InFile<Self::Ast>> {
Some(self.source)
}
}