//! FIXME: write short doc here use std::sync::Arc; use ra_syntax::ast; use crate::{ db::{AstDatabase, DefDatabase, HirDatabase}, Adt, Const, Enum, EnumVariant, FieldSource, Function, HasSource, MacroDef, Module, Static, Struct, StructField, Trait, TypeAlias, Union, }; #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] pub enum DocDef { Module(Module), StructField(StructField), Adt(Adt), EnumVariant(EnumVariant), Static(Static), Const(Const), Function(Function), Trait(Trait), TypeAlias(TypeAlias), MacroDef(MacroDef), } impl_froms!( DocDef: Module, StructField, Adt(Struct, Enum, Union), EnumVariant, Static, Const, Function, Trait, TypeAlias, MacroDef ); /// Holds documentation #[derive(Debug, Clone, PartialEq, Eq)] pub struct Documentation(Arc); impl Documentation { fn new(s: &str) -> Documentation { Documentation(s.into()) } pub fn as_str(&self) -> &str { &*self.0 } } impl Into for Documentation { fn into(self) -> String { self.as_str().to_owned() } } pub trait Docs { fn docs(&self, db: &impl HirDatabase) -> Option; } pub(crate) fn docs_from_ast(node: &impl ast::DocCommentsOwner) -> Option { node.doc_comment_text().map(|it| Documentation::new(&it)) } pub(crate) fn documentation_query( db: &(impl DefDatabase + AstDatabase), def: DocDef, ) -> Option { match def { DocDef::Module(it) => docs_from_ast(&it.declaration_source(db)?.ast), DocDef::StructField(it) => match it.source(db).ast { FieldSource::Named(named) => docs_from_ast(&named), FieldSource::Pos(..) => None, }, DocDef::Adt(it) => match it { Adt::Struct(it) => docs_from_ast(&it.source(db).ast), Adt::Enum(it) => docs_from_ast(&it.source(db).ast), Adt::Union(it) => docs_from_ast(&it.source(db).ast), }, DocDef::EnumVariant(it) => docs_from_ast(&it.source(db).ast), DocDef::Static(it) => docs_from_ast(&it.source(db).ast), DocDef::Const(it) => docs_from_ast(&it.source(db).ast), DocDef::Function(it) => docs_from_ast(&it.source(db).ast), DocDef::Trait(it) => docs_from_ast(&it.source(db).ast), DocDef::TypeAlias(it) => docs_from_ast(&it.source(db).ast), DocDef::MacroDef(it) => docs_from_ast(&it.source(db).ast), } } impl + Copy> Docs for T { fn docs(&self, db: &impl HirDatabase) -> Option { db.documentation((*self).into()) } }