rust-analyzer/crates/ra_hir/src/code_model/src.rs

//! FIXME: write short doc here

use hir_def::{HasChildSource, HasSource as _, Lookup, VariantId};
use hir_expand::either::Either;
use ra_syntax::ast::{self, AstNode};

use crate::{
    db::{DefDatabase, HirDatabase},
    ids::AstItemDef,
    Const, Enum, EnumVariant, FieldSource, Function, HasBody, Import, MacroDef, Module,
    ModuleSource, Static, Struct, StructField, Trait, TypeAlias, Union,
};

pub use hir_expand::Source;

pub trait HasSource {
    type Ast;
    fn source(self, db: &impl DefDatabase) -> Source<Self::Ast>;
}

/// NB: Module is !HasSource, because it has two source nodes at the same time:
/// 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: &impl DefDatabase) -> Source<ModuleSource> {
        let def_map = db.crate_def_map(self.id.krate);
        let src = def_map[self.id.module_id].definition_source(db);
        src.map(|it| match it {
            Either::A(it) => ModuleSource::SourceFile(it),
            Either::B(it) => ModuleSource::Module(it),
        })
    }

    /// 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: &impl DefDatabase) -> Option<Source<ast::Module>> {
        let def_map = db.crate_def_map(self.id.krate);
        def_map[self.id.module_id].declaration_source(db)
    }
}

impl HasSource for StructField {
    type Ast = FieldSource;
    fn source(self, db: &impl DefDatabase) -> Source<FieldSource> {
        let var = VariantId::from(self.parent);
        let src = var.child_source(db);
        src.map(|it| match it[self.id].clone() {
            Either::A(it) => FieldSource::Pos(it),
            Either::B(it) => FieldSource::Named(it),
        })
    }
}
impl HasSource for Struct {
    type Ast = ast::StructDef;
    fn source(self, db: &impl DefDatabase) -> Source<ast::StructDef> {
        self.id.0.source(db)
    }
}
impl HasSource for Union {
    type Ast = ast::StructDef;
    fn source(self, db: &impl DefDatabase) -> Source<ast::StructDef> {
        self.id.0.source(db)
    }
}
impl HasSource for Enum {
    type Ast = ast::EnumDef;
    fn source(self, db: &impl DefDatabase) -> Source<ast::EnumDef> {
        self.id.source(db)
    }
}
impl HasSource for EnumVariant {
    type Ast = ast::EnumVariant;
    fn source(self, db: &impl DefDatabase) -> Source<ast::EnumVariant> {
        self.parent.id.child_source(db).map(|map| map[self.id].clone())
    }
}
impl HasSource for Function {
    type Ast = ast::FnDef;
    fn source(self, db: &impl DefDatabase) -> Source<ast::FnDef> {
        self.id.lookup(db).source(db)
    }
}
impl HasSource for Const {
    type Ast = ast::ConstDef;
    fn source(self, db: &impl DefDatabase) -> Source<ast::ConstDef> {
        self.id.lookup(db).source(db)
    }
}
impl HasSource for Static {
    type Ast = ast::StaticDef;
    fn source(self, db: &impl DefDatabase) -> Source<ast::StaticDef> {
        self.id.source(db)
    }
}
impl HasSource for Trait {
    type Ast = ast::TraitDef;
    fn source(self, db: &impl DefDatabase) -> Source<ast::TraitDef> {
        self.id.source(db)
    }
}
impl HasSource for TypeAlias {
    type Ast = ast::TypeAliasDef;
    fn source(self, db: &impl DefDatabase) -> Source<ast::TypeAliasDef> {
        self.id.lookup(db).source(db)
    }
}
impl HasSource for MacroDef {
    type Ast = ast::MacroCall;
    fn source(self, db: &impl DefDatabase) -> Source<ast::MacroCall> {
        Source { file_id: self.id.ast_id.file_id(), value: self.id.ast_id.to_node(db) }
    }
}
impl HasSource for Import {
    type Ast = Either<ast::UseTree, ast::ExternCrateItem>;

    /// Returns the syntax of the last path segment corresponding to this import
    fn source(self, db: &impl DefDatabase) -> Source<Self::Ast> {
        let src = self.parent.definition_source(db);
        let (_, source_map) = db.raw_items_with_source_map(src.file_id);
        src.with_value(source_map.get(&src.value, self.id))
    }
}

pub trait HasBodySource: HasBody + HasSource
where
    Self::Ast: AstNode,
{
    fn expr_source(
        self,
        db: &impl HirDatabase,
        expr_id: crate::expr::ExprId,
    ) -> Option<Source<Either<ast::Expr, ast::RecordField>>> {
        let source_map = self.body_source_map(db);
        let source_ptr = source_map.expr_syntax(expr_id)?;
        let root = source_ptr.file_syntax(db);
        let source = source_ptr.map(|ast| ast.map(|it| it.to_node(&root), |it| it.to_node(&root)));
        Some(source)
    }
}

impl<T> HasBodySource for T
where
    T: HasBody + HasSource,
    T::Ast: AstNode,
{
}